KratosMultiphysics
KRATOS Multiphysics (Kratos) is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface.
Classes | List of all members
Kratos::array_1d< T, N > Class Template Reference

Short class definition. More...

#include <array_1d.h>

Inheritance diagram for Kratos::array_1d< T, N >:
Collaboration diagram for Kratos::array_1d< T, N >:

Classes

class  const_iterator
 
class  iterator
 

Public Member Functions

Life Cycle
BOOST_UBLAS_INLINE array_1d ()
 Default constructor. More...
 
BOOST_UBLAS_INLINE array_1d (size_type array_size)
 
BOOST_UBLAS_INLINE array_1d (size_type array_size, value_type v)
 
BOOST_UBLAS_INLINE array_1d (const std::initializer_list< value_type > &rInitList)
 
BOOST_UBLAS_INLINE array_1d (size_type array_size, const array_type &rdata)
 
BOOST_UBLAS_INLINE array_1d (const array_1d &v)
 
template<class AE >
BOOST_UBLAS_INLINE array_1d (const boost::numeric::ublas::vector_expression< AE > &ae)
 
Operators
BOOST_UBLAS_INLINE const_reference operator() (size_type i) const
 
BOOST_UBLAS_INLINE reference operator() (size_type i)
 
BOOST_UBLAS_INLINE const_reference operator[] (size_type i) const
 
BOOST_UBLAS_INLINE reference operator[] (size_type i)
 
BOOST_UBLAS_INLINE array_1d & operator= (const array_1d &v)
 
template<class AE >
BOOST_UBLAS_INLINE array_1d & operator= (const boost::numeric::ublas::vector_expression< AE > &ae)
 
template<class AE >
BOOST_UBLAS_INLINE array_1d & operator+= (const boost::numeric::ublas::vector_expression< AE > &ae)
 
template<class AE >
BOOST_UBLAS_INLINE array_1d & operator-= (const boost::numeric::ublas::vector_expression< AE > &ae)
 
template<class AT >
BOOST_UBLAS_INLINE array_1d & operator/= (const AT &at)
 
BOOST_UBLAS_INLINE bool operator== (const array_1d &v) const
 Compares whether this array_1d is equal to the given array_1d. More...
 

Type Definitions

typedef std::size_t size_type
 
typedef std::ptrdiff_t difference_type
 
typedef T value_type
 
typedef boost::numeric::ublas::type_traits< T >::const_reference const_reference
 
typedef T & reference
 
typedef std::array< T, N > array_type
 
typedef T * pointer
 
typedef array_1d< T, N > self_type
 
typedef const boost::numeric::ublas::vector_reference< const self_type > const_closure_type
 
typedef boost::numeric::ublas::vector_reference< self_type > closure_type
 
typedef self_type vector_temporary_type
 
typedef boost::numeric::ublas::dense_tag storage_category
 
 KRATOS_CLASS_POINTER_DEFINITION (array_1d)
 Pointer definition of array_1d. More...
 

Access

typedef boost::numeric::ublas::reverse_iterator_base< const_iterator > const_reverse_iterator
 
typedef boost::numeric::ublas::reverse_iterator_base< iterator > reverse_iterator
 
BOOST_UBLAS_INLINE const_iterator find (size_type i) const
 
BOOST_UBLAS_INLINE iterator find (size_type i)
 
BOOST_UBLAS_INLINE size_type size () const
 
template<class AE >
BOOST_UBLAS_INLINE array_1d & minus_assign (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE const array_type & data () const
 
BOOST_UBLAS_INLINE array_type & data ()
 
BOOST_UBLAS_INLINE const_iterator begin () const
 
BOOST_UBLAS_INLINE const_iterator end () const
 
BOOST_UBLAS_INLINE iterator begin ()
 
BOOST_UBLAS_INLINE iterator end ()
 
BOOST_UBLAS_INLINE const_reverse_iterator rbegin () const
 
BOOST_UBLAS_INLINE const_reverse_iterator rend () const
 
BOOST_UBLAS_INLINE reverse_iterator rbegin ()
 
BOOST_UBLAS_INLINE reverse_iterator rend ()
 

Operations

BOOST_UBLAS_INLINE void resize (size_type array_size, bool preserve=true)
 
BOOST_UBLAS_INLINE array_1d & assign_temporary (array_1d &v)
 
template<class AT >
BOOST_UBLAS_INLINE array_1d & operator*= (const AT &at)
 
template<class AE >
BOOST_UBLAS_INLINE array_1d & plus_assign (const boost::numeric::ublas::vector_expression< AE > &ae)
 
template<class AE >
BOOST_UBLAS_INLINE array_1d & assign (const boost::numeric::ublas::vector_expression< AE > &ae)
 
BOOST_UBLAS_INLINE void swap (array_1d &v)
 
BOOST_UBLAS_INLINE reference insert_element (size_type i, const_reference t)
 
BOOST_UBLAS_INLINE void erase_element (size_type i)
 
BOOST_UBLAS_INLINE void clear ()
 
BOOST_UBLAS_INLINE friend void swap (array_1d &v1, array_1d &v2)
 

Detailed Description

template<class T, std::size_t N>
class Kratos::array_1d< T, N >

Short class definition.

Detail class definition.

Member Typedef Documentation

◆ array_type

template<class T , std::size_t N>
typedef std::array<T,N> Kratos::array_1d< T, N >::array_type

◆ closure_type

template<class T , std::size_t N>
typedef boost::numeric::ublas::vector_reference<self_type> Kratos::array_1d< T, N >::closure_type

◆ const_closure_type

template<class T , std::size_t N>
typedef const boost::numeric::ublas::vector_reference<const self_type> Kratos::array_1d< T, N >::const_closure_type

◆ const_reference

template<class T , std::size_t N>
typedef boost::numeric::ublas::type_traits<T>::const_reference Kratos::array_1d< T, N >::const_reference

◆ const_reverse_iterator

template<class T , std::size_t N>
typedef boost::numeric::ublas::reverse_iterator_base<const_iterator> Kratos::array_1d< T, N >::const_reverse_iterator

◆ difference_type

template<class T , std::size_t N>
typedef std::ptrdiff_t Kratos::array_1d< T, N >::difference_type

◆ pointer

template<class T , std::size_t N>
typedef T* Kratos::array_1d< T, N >::pointer

◆ reference

template<class T , std::size_t N>
typedef T& Kratos::array_1d< T, N >::reference

◆ reverse_iterator

template<class T , std::size_t N>
typedef boost::numeric::ublas::reverse_iterator_base<iterator> Kratos::array_1d< T, N >::reverse_iterator

◆ self_type

template<class T , std::size_t N>
typedef array_1d<T, N> Kratos::array_1d< T, N >::self_type

◆ size_type

template<class T , std::size_t N>
typedef std::size_t Kratos::array_1d< T, N >::size_type

◆ storage_category

template<class T , std::size_t N>
typedef boost::numeric::ublas::dense_tag Kratos::array_1d< T, N >::storage_category

◆ value_type

template<class T , std::size_t N>
typedef T Kratos::array_1d< T, N >::value_type

◆ vector_temporary_type

template<class T , std::size_t N>
typedef self_type Kratos::array_1d< T, N >::vector_temporary_type

Constructor & Destructor Documentation

◆ array_1d() [1/7]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE Kratos::array_1d< T, N >::array_1d ( )
inline

Default constructor.

◆ array_1d() [2/7]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE Kratos::array_1d< T, N >::array_1d ( size_type  array_size)
inlineexplicit

◆ array_1d() [3/7]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE Kratos::array_1d< T, N >::array_1d ( size_type  array_size,
value_type  v 
)
inlineexplicit

◆ array_1d() [4/7]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE Kratos::array_1d< T, N >::array_1d ( const std::initializer_list< value_type > &  rInitList)
inlineexplicit

◆ array_1d() [5/7]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE Kratos::array_1d< T, N >::array_1d ( size_type  array_size,
const array_type &  rdata 
)
inline

◆ array_1d() [6/7]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE Kratos::array_1d< T, N >::array_1d ( const array_1d< T, N > &  v)
inline

◆ array_1d() [7/7]

template<class T , std::size_t N>
template<class AE >
BOOST_UBLAS_INLINE Kratos::array_1d< T, N >::array_1d ( const boost::numeric::ublas::vector_expression< AE > &  ae)
inline

Member Function Documentation

◆ assign()

template<class T , std::size_t N>
template<class AE >
BOOST_UBLAS_INLINE array_1d& Kratos::array_1d< T, N >::assign ( const boost::numeric::ublas::vector_expression< AE > &  ae)
inline

◆ assign_temporary()

template<class T , std::size_t N>
BOOST_UBLAS_INLINE array_1d& Kratos::array_1d< T, N >::assign_temporary ( array_1d< T, N > &  v)
inline

◆ begin() [1/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE iterator Kratos::array_1d< T, N >::begin ( )
inline

◆ begin() [2/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE const_iterator Kratos::array_1d< T, N >::begin ( ) const
inline

◆ clear()

template<class T , std::size_t N>
BOOST_UBLAS_INLINE void Kratos::array_1d< T, N >::clear ( )
inline

◆ data() [1/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE array_type& Kratos::array_1d< T, N >::data ( )
inline

◆ data() [2/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE const array_type& Kratos::array_1d< T, N >::data ( ) const
inline

◆ end() [1/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE iterator Kratos::array_1d< T, N >::end ( )
inline

◆ end() [2/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE const_iterator Kratos::array_1d< T, N >::end ( ) const
inline

◆ erase_element()

template<class T , std::size_t N>
BOOST_UBLAS_INLINE void Kratos::array_1d< T, N >::erase_element ( size_type  i)
inline

◆ find() [1/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE iterator Kratos::array_1d< T, N >::find ( size_type  i)
inline

◆ find() [2/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE const_iterator Kratos::array_1d< T, N >::find ( size_type  i) const
inline

◆ insert_element()

template<class T , std::size_t N>
BOOST_UBLAS_INLINE reference Kratos::array_1d< T, N >::insert_element ( size_type  i,
const_reference  t 
)
inline

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class T , std::size_t N>
Kratos::array_1d< T, N >::KRATOS_CLASS_POINTER_DEFINITION ( array_1d< T, N >  )

Pointer definition of array_1d.

◆ minus_assign()

template<class T , std::size_t N>
template<class AE >
BOOST_UBLAS_INLINE array_1d& Kratos::array_1d< T, N >::minus_assign ( const boost::numeric::ublas::vector_expression< AE > &  ae)
inline

◆ operator()() [1/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE reference Kratos::array_1d< T, N >::operator() ( size_type  i)
inline

◆ operator()() [2/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE const_reference Kratos::array_1d< T, N >::operator() ( size_type  i) const
inline

◆ operator*=()

template<class T , std::size_t N>
template<class AT >
BOOST_UBLAS_INLINE array_1d& Kratos::array_1d< T, N >::operator*= ( const AT &  at)
inline

◆ operator+=()

template<class T , std::size_t N>
template<class AE >
BOOST_UBLAS_INLINE array_1d& Kratos::array_1d< T, N >::operator+= ( const boost::numeric::ublas::vector_expression< AE > &  ae)
inline

◆ operator-=()

template<class T , std::size_t N>
template<class AE >
BOOST_UBLAS_INLINE array_1d& Kratos::array_1d< T, N >::operator-= ( const boost::numeric::ublas::vector_expression< AE > &  ae)
inline

◆ operator/=()

template<class T , std::size_t N>
template<class AT >
BOOST_UBLAS_INLINE array_1d& Kratos::array_1d< T, N >::operator/= ( const AT &  at)
inline

◆ operator=() [1/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE array_1d& Kratos::array_1d< T, N >::operator= ( const array_1d< T, N > &  v)
inline

◆ operator=() [2/2]

template<class T , std::size_t N>
template<class AE >
BOOST_UBLAS_INLINE array_1d& Kratos::array_1d< T, N >::operator= ( const boost::numeric::ublas::vector_expression< AE > &  ae)
inline

◆ operator==()

template<class T , std::size_t N>
BOOST_UBLAS_INLINE bool Kratos::array_1d< T, N >::operator== ( const array_1d< T, N > &  v) const
inline

Compares whether this array_1d is equal to the given array_1d.

Parameters
vthe array_1d to compare to
Returns
true if the two arrays are equal, false otherwise

◆ operator[]() [1/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE reference Kratos::array_1d< T, N >::operator[] ( size_type  i)
inline

◆ operator[]() [2/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE const_reference Kratos::array_1d< T, N >::operator[] ( size_type  i) const
inline

◆ plus_assign()

template<class T , std::size_t N>
template<class AE >
BOOST_UBLAS_INLINE array_1d& Kratos::array_1d< T, N >::plus_assign ( const boost::numeric::ublas::vector_expression< AE > &  ae)
inline

◆ rbegin() [1/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE reverse_iterator Kratos::array_1d< T, N >::rbegin ( )
inline

◆ rbegin() [2/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE const_reverse_iterator Kratos::array_1d< T, N >::rbegin ( ) const
inline

◆ rend() [1/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE reverse_iterator Kratos::array_1d< T, N >::rend ( )
inline

◆ rend() [2/2]

template<class T , std::size_t N>
BOOST_UBLAS_INLINE const_reverse_iterator Kratos::array_1d< T, N >::rend ( ) const
inline

◆ resize()

template<class T , std::size_t N>
BOOST_UBLAS_INLINE void Kratos::array_1d< T, N >::resize ( size_type  array_size,
bool  preserve = true 
)
inline

◆ size()

template<class T , std::size_t N>
BOOST_UBLAS_INLINE size_type Kratos::array_1d< T, N >::size ( ) const
inline

◆ swap()

template<class T , std::size_t N>
BOOST_UBLAS_INLINE void Kratos::array_1d< T, N >::swap ( array_1d< T, N > &  v)
inline

Friends And Related Function Documentation

◆ swap

template<class T , std::size_t N>
BOOST_UBLAS_INLINE friend void swap ( array_1d< T, N > &  v1,
array_1d< T, N > &  v2 
)
friend
The documentation for this class was generated from the following file:
Generated on Sat Feb 3 2024 02:51:00 for KratosMultiphysics by doxygen 1.9.1