Nektar::Array< TwoD, DataType > Class Template Reference

A 2D array. More...

#include <SharedArray.hpp>

Inheritance diagram for Nektar::Array< TwoD, DataType >:

Public Types
typedef Array< TwoD, const DataType >	BaseType
typedef BaseType::iterator	iterator
typedef BaseType::reference	reference
typedef BaseType::index	index
typedef BaseType::size_type	size_type
typedef BaseType::element	element
Public Types inherited from Nektar::Array< TwoD, const DataType >
typedef boost::multi_array_ref< DataType, 2 >	ArrayType
typedef ArrayType::const_reference	const_reference
typedef ArrayType::reference	reference
typedef ArrayType::index	index
typedef ArrayType::const_iterator	const_iterator
typedef ArrayType::iterator	iterator
typedef ArrayType::element	element
typedef ArrayType::size_type	size_type

Public Member Functions
	Array ()
	Array (size_type dim1Size, size_type dim2Size)
	Array (size_type dim1Size, size_type dim2Size, const DataType &initValue)
	Array (size_type dim1Size, size_type dim2Size, const DataType *data)
	Array (const Array< TwoD, DataType > &rhs)
Array< TwoD, DataType > &	operator= (const Array< TwoD, DataType > &rhs)
iterator	begin ()
iterator	end ()
reference	operator[] (index i)
element *	get ()
element *	data ()
const_iterator	begin () const
const_iterator	end () const
const element *	get () const
const element *	data () const
Public Member Functions inherited from Nektar::Array< TwoD, const DataType >
	Array ()
	Array (size_type dim1Size, size_type dim2Size)
	Constructs a 2 dimensional array. The elements of the array are not initialized. More...
	Array (size_type dim1Size, size_type dim2Size, const DataType &initValue)
	Array (size_type dim1Size, size_type dim2Size, const DataType *data)
	Array (const Array< TwoD, const DataType > &rhs)
Array< TwoD, const DataType > &	operator= (const Array< TwoD, const DataType > &rhs)
const_iterator	begin () const
const_iterator	end () const
const_reference	operator[] (index i) const
const element *	get () const
const element *	data () const
size_type	num_dimensions () const
const size_type *	shape () const
size_type	size () const
size_type	num_elements () const
size_type	GetRows () const
size_type	GetColumns () const

Additional Inherited Members
Protected Attributes inherited from Nektar::Array< TwoD, const DataType >
std::shared_ptr< ArrayType >	m_data

Detailed Description

template<typename DataType>
class Nektar::Array< TwoD, DataType >

A 2D array.

Definition at line 724 of file SharedArray.hpp.

Member Typedef Documentation

BaseType

template<typename DataType >

typedef Array<TwoD, const DataType> Nektar::Array< TwoD, DataType >::BaseType

Definition at line 727 of file SharedArray.hpp.

element

template<typename DataType >

typedef BaseType::element Nektar::Array< TwoD, DataType >::element

Definition at line 732 of file SharedArray.hpp.

index

template<typename DataType >

typedef BaseType::index Nektar::Array< TwoD, DataType >::index

Definition at line 730 of file SharedArray.hpp.

iterator

template<typename DataType >

typedef BaseType::iterator Nektar::Array< TwoD, DataType >::iterator

Definition at line 728 of file SharedArray.hpp.

reference

template<typename DataType >

typedef BaseType::reference Nektar::Array< TwoD, DataType >::reference

Definition at line 729 of file SharedArray.hpp.

size_type

template<typename DataType >

typedef BaseType::size_type Nektar::Array< TwoD, DataType >::size_type

Definition at line 731 of file SharedArray.hpp.

Constructor & Destructor Documentation

Array() [1/5]

template<typename DataType >

Nektar::Array< TwoD, DataType >::Array ( )

inline

Definition at line 735 of file SharedArray.hpp.

            : BaseType()
    {
    }

Array() [2/5]

template<typename DataType >

Nektar::Array< TwoD, DataType >::Array ( size_type  dim1Size, size_type  dim2Size  )

inline

Definition at line 739 of file SharedArray.hpp.

                                                  : BaseType(dim1Size, dim2Size)
    {
    }

Array() [3/5]

template<typename DataType >

Nektar::Array< TwoD, DataType >::Array ( size_type  dim1Size, size_type  dim2Size, const DataType &  initValue  )

inline

Definition at line 743 of file SharedArray.hpp.

        : BaseType(dim1Size, dim2Size, initValue)
    {
    }

Array() [4/5]

template<typename DataType >

Nektar::Array< TwoD, DataType >::Array ( size_type  dim1Size, size_type  dim2Size, const DataType *  data  )

inline

Definition at line 748 of file SharedArray.hpp.

        : BaseType(dim1Size, dim2Size, data)
    {
    }

Array() [5/5]

template<typename DataType >

Nektar::Array< TwoD, DataType >::Array ( const Array< TwoD, DataType > &  rhs )

inline

Definition at line 753 of file SharedArray.hpp.

                                            : BaseType(rhs)
    {
    }

Member Function Documentation

begin() [1/2]

template<typename DataType >

iterator Nektar::Array< TwoD, DataType >::begin ( )

inline

Definition at line 764 of file SharedArray.hpp.

    {
        return this->m_data->begin();
    }

begin() [2/2]

template<typename DataType >

const_iterator Nektar::Array< TwoD, const DataType >::begin ( ) const

inline

Definition at line 507 of file SharedArray.hpp.

    {
        return m_data->begin();
    }

data() [1/2]

template<typename DataType >

element * Nektar::Array< TwoD, DataType >::data ( )

inline

Definition at line 788 of file SharedArray.hpp.

    {
        return this->m_data->data();
    }

data() [2/2]

template<typename DataType >

const element * Nektar::Array< TwoD, const DataType >::data ( ) const

inline

Definition at line 523 of file SharedArray.hpp.

    {
        return m_data->data();
    }

end() [1/2]

template<typename DataType >

iterator Nektar::Array< TwoD, DataType >::end ( )

inline

Definition at line 770 of file SharedArray.hpp.

    {
        return this->m_data->end();
    }

end() [2/2]

template<typename DataType >

const_iterator Nektar::Array< TwoD, const DataType >::end ( ) const

inline

Definition at line 511 of file SharedArray.hpp.

    {
        return m_data->end();
    }

get() [1/2]

template<typename DataType >

element * Nektar::Array< TwoD, DataType >::get ( )

inline

Definition at line 782 of file SharedArray.hpp.

    {
        return this->m_data->data();
    }

get() [2/2]

template<typename DataType >

const element * Nektar::Array< TwoD, const DataType >::get ( ) const

inline

Definition at line 519 of file SharedArray.hpp.

    {
        return m_data->data();
    }

operator=()

template<typename DataType >

Array< TwoD, DataType > & Nektar::Array< TwoD, DataType >::operator= ( const Array< TwoD, DataType > &  rhs )

inline

Definition at line 757 of file SharedArray.hpp.

    {
        BaseType::operator=(rhs);
        return *this;
    }

operator[]()

template<typename DataType >

reference Nektar::Array< TwoD, DataType >::operator[] ( index  i )

inline

Definition at line 776 of file SharedArray.hpp.

    {
        return (*this->m_data)[i];
    }