MOAB  4.9.3pre
Public Types | Public Member Functions | Friends
Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > Class Template Reference

General-purpose arrays with easy API for coefficient-wise operations. More...

#include <Array.h>

Inheritance diagram for Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >:
Inheritance graph
[legend]
Collaboration diagram for Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >:
Collaboration graph
[legend]

List of all members.

Public Types

enum  { Options = _Options }
typedef PlainObjectBase< Array > Base
typedef Base::PlainObject PlainObject

Public Member Functions

template<typename OtherDerived >
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE Array & 		operator= (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE Array & 		operator= (const Scalar &value)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE Array & 		operator= (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE Array & 		operator= (const Array &other)
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE 		Array ()
EIGEN_DEVICE_FUNC Array (internal::constructor_without_unaligned_array_assert)
template<typename T >
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE 		Array (const T &x)
template<typename T0 , typename T1 >
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE 		Array (const T0 &val0, const T1 &val1)
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE 		Array (const Scalar &val0, const Scalar &val1, const Scalar &val2)
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE 		Array (const Scalar &val0, const Scalar &val1, const Scalar &val2, const Scalar &val3)
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE 		Array (const Array &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE 		Array (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC Index innerStride () const
EIGEN_DEVICE_FUNC Index outerStride () const

Friends

struct internal::conservative_resize_like_impl
struct internal::matrix_swap_impl

Detailed Description

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
class Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >

General-purpose arrays with easy API for coefficient-wise operations.

The Array class is very similar to the Matrix class. It provides general-purpose one- and two-dimensional arrays. The difference between the Array and the Matrix class is primarily in the API: the API for the Array class provides easy access to coefficient-wise operations, while the API for the Matrix class provides easy access to linear-algebra operations.

See documentation of class Matrix for detailed information on the template parameters storage layout.

This class can be extended with the help of the plugin mechanism described on the page TopicCustomizingEigen by defining the preprocessor symbol EIGEN_ARRAY_PLUGIN.

See also:
TutorialArrayClass, TopicClassHierarchy

Definition at line 45 of file Array.h.

Member Typedef Documentation

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
typedef PlainObjectBase<Array> Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Base

Reimplemented from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.

Definition at line 50 of file Array.h.

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
typedef Base::PlainObject Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::PlainObject

Definition at line 54 of file Array.h.

Member Enumeration Documentation

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
anonymous enum
Enumerator:
Options 

Definition at line 53 of file Array.h.

{ Options = _Options };

Constructor & Destructor Documentation

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array ( ) [inline]

Default constructor.

For fixed-size matrices, does nothing.

For dynamic-size matrices, creates an empty matrix of size 0. Does not allocate any array. Such a matrix is called a null matrix. This constructor is the unique way to create null matrices: resizing a matrix to 0 is not supported.

See also:
resize(Index,Index)

Definition at line 132 of file Array.h.

                                : Base()
    {
      Base::_check_template_params();
      EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
    }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
EIGEN_DEVICE_FUNC Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array ( internal::constructor_without_unaligned_array_assert  ) [inline]

Definition at line 142 of file Array.h.

      : Base(internal::constructor_without_unaligned_array_assert())
    {
      Base::_check_template_params();
      EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
    }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array ( const T &  x) [inline, explicit]

Definition at line 170 of file Array.h.

    {
      Base::_check_template_params();
      Base::template _init1<T>(x);
    }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
template<typename T0 , typename T1 >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array ( const T0 &  val0,
const T1 &  val1 
) [inline]

Definition at line 178 of file Array.h.

    {
      Base::_check_template_params();
      this->template _init2<T0,T1>(val0, val1);
    }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array ( const Scalar &  val0,
const Scalar &  val1,
const Scalar &  val2 
) [inline]

constructs an initialized 3D vector with given coefficients

Definition at line 208 of file Array.h.

    {
      Base::_check_template_params();
      EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Array, 3)
      m_storage.data()[0] = val0;
      m_storage.data()[1] = val1;
      m_storage.data()[2] = val2;
    }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array ( const Scalar &  val0,
const Scalar &  val1,
const Scalar &  val2,
const Scalar &  val3 
) [inline]

constructs an initialized 4D vector with given coefficients

Definition at line 218 of file Array.h.

    {
      Base::_check_template_params();
      EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Array, 4)
      m_storage.data()[0] = val0;
      m_storage.data()[1] = val1;
      m_storage.data()[2] = val2;
      m_storage.data()[3] = val3;
    }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array ( const Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &  other) [inline]

Copy constructor

Definition at line 230 of file Array.h.

            : Base(other)
    { }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array ( const EigenBase< OtherDerived > &  other) [inline]
See also:
MatrixBase::operator=(const EigenBase<OtherDerived>&)

Definition at line 237 of file Array.h.

      : Base(other.derived())
    { }

Member Function Documentation

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
EIGEN_DEVICE_FUNC Index Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::innerStride ( ) const [inline]

Definition at line 241 of file Array.h.

{ return 1; }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array& Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const EigenBase< OtherDerived > &  other) [inline]

The usage of using Base::operator=; fails on MSVC. Since the code below is working with GCC and MSVC, we skipped the usage of 'using'. This should be done only for operator=.

Reimplemented from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.

Definition at line 76 of file Array.h.

    {
      return Base::operator=(other);
    }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array& Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const Scalar &  value) [inline]

Set all the entries to value.

See also:
DenseBase::setConstant(), DenseBase::fill()

Definition at line 90 of file Array.h.

    {
      Base::setConstant(value);
      return *this;
    }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array& Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const DenseBase< OtherDerived > &  other) [inline]

Copies the value of the expression other into *this with automatic resizing.

*this might be resized to match the dimensions of other. If *this was a null matrix (not already initialized), it will be initialized.

Note that copying a row-vector into a vector (and conversely) is allowed. The resizing, if any, is then done in the appropriate way so that row-vectors remain row-vectors and vectors remain vectors.

Definition at line 107 of file Array.h.

    {
      return Base::_set(other);
    }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array& Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &  other) [inline]

This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.

Definition at line 116 of file Array.h.

    {
      return Base::_set(other);
    }
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
EIGEN_DEVICE_FUNC Index Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::outerStride ( ) const [inline]

Definition at line 242 of file Array.h.

{ return this->innerSize(); }

Friends And Related Function Documentation

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
friend struct internal::conservative_resize_like_impl [friend]

Definition at line 58 of file Array.h.

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
friend struct internal::matrix_swap_impl [friend]

Reimplemented from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.

Definition at line 251 of file Array.h.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines