Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | List of all members
Nektar::Array< ThreeD, DataType > Class Template Reference

A 3D array. More...

#include <SharedArray.hpp>

Inheritance diagram for Nektar::Array< ThreeD, DataType >:
Inheritance graph
[legend]
Collaboration diagram for Nektar::Array< ThreeD, DataType >:
Collaboration graph
[legend]

Public Types

typedef Array< ThreeD, 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< ThreeD, const DataType >
typedef boost::multi_array_ref
< DataType, 3 > 
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 (unsigned int dim1Size, unsigned int dim2Size, unsigned int dim3Size)
 Constructs a 3 dimensional array. The elements of the array are not initialized.
 Array (unsigned int dim1Size, unsigned int dim2Size, unsigned int dim3Size, const DataType &initValue)
 Array (const Array< ThreeD, DataType > &rhs)
Array< ThreeD, DataType > & operator= (const Array< ThreeD, DataType > &rhs)
iterator begin ()
iterator end ()
reference operator[] (index i)
elementget ()
elementdata ()
- Public Member Functions inherited from Nektar::Array< ThreeD, const DataType >
 Array (const Array< ThreeD, const DataType > &rhs)
Array< ThreeD, const DataType > & operator= (const Array< ThreeD, const DataType > &rhs)
const_iterator begin () const
const_iterator end () const
const_reference operator[] (index i) const
const elementget () const
const elementdata () const
size_type num_dimensions () const
const size_typeshape () const
size_type num_elements () const

Additional Inherited Members

- Protected Attributes inherited from Nektar::Array< ThreeD, const DataType >
boost::shared_ptr< ArrayTypem_data

Detailed Description

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

A 3D array.

Definition at line 652 of file SharedArray.hpp.

Member Typedef Documentation

template<typename DataType >
typedef Array<ThreeD, const DataType> Nektar::Array< ThreeD, DataType >::BaseType

Definition at line 655 of file SharedArray.hpp.

template<typename DataType >
typedef BaseType::element Nektar::Array< ThreeD, DataType >::element

Definition at line 660 of file SharedArray.hpp.

template<typename DataType >
typedef BaseType::index Nektar::Array< ThreeD, DataType >::index

Definition at line 658 of file SharedArray.hpp.

template<typename DataType >
typedef BaseType::iterator Nektar::Array< ThreeD, DataType >::iterator

Definition at line 656 of file SharedArray.hpp.

template<typename DataType >
typedef BaseType::reference Nektar::Array< ThreeD, DataType >::reference

Definition at line 657 of file SharedArray.hpp.

template<typename DataType >
typedef BaseType::size_type Nektar::Array< ThreeD, DataType >::size_type

Definition at line 659 of file SharedArray.hpp.

Constructor & Destructor Documentation

template<typename DataType >
Nektar::Array< ThreeD, DataType >::Array ( )
inline

Reimplemented from Nektar::Array< ThreeD, const DataType >.

Definition at line 663 of file SharedArray.hpp.

:
{
}
template<typename DataType >
Nektar::Array< ThreeD, DataType >::Array ( unsigned int  dim1Size,
unsigned int  dim2Size,
unsigned int  dim3Size 
)
inline

Constructs a 3 dimensional array. The elements of the array are not initialized.

Reimplemented from Nektar::Array< ThreeD, const DataType >.

Definition at line 668 of file SharedArray.hpp.

:
BaseType(dim1Size, dim2Size, dim3Size)
{
}
template<typename DataType >
Nektar::Array< ThreeD, DataType >::Array ( unsigned int  dim1Size,
unsigned int  dim2Size,
unsigned int  dim3Size,
const DataType &  initValue 
)
inline

Reimplemented from Nektar::Array< ThreeD, const DataType >.

Definition at line 673 of file SharedArray.hpp.

:
BaseType(dim1Size, dim2Size, dim3Size, initValue)
{
}
template<typename DataType >
Nektar::Array< ThreeD, DataType >::Array ( const Array< ThreeD, DataType > &  rhs)
inline

Definition at line 678 of file SharedArray.hpp.

:
BaseType(rhs)
{
}

Member Function Documentation

template<typename DataType >
iterator Nektar::Array< ThreeD, DataType >::begin ( )
inline

Definition at line 690 of file SharedArray.hpp.

{ return this->m_data->begin(); }
template<typename DataType >
element* Nektar::Array< ThreeD, DataType >::data ( )
inline

Definition at line 702 of file SharedArray.hpp.

{ return this->m_data->data(); }
template<typename DataType >
iterator Nektar::Array< ThreeD, DataType >::end ( )
inline

Definition at line 693 of file SharedArray.hpp.

{ return this->m_data->end(); }
template<typename DataType >
element* Nektar::Array< ThreeD, DataType >::get ( )
inline

Definition at line 699 of file SharedArray.hpp.

{ return this->m_data->data(); }
template<typename DataType >
Array<ThreeD, DataType>& Nektar::Array< ThreeD, DataType >::operator= ( const Array< ThreeD, DataType > &  rhs)
inline

Definition at line 683 of file SharedArray.hpp.

{
BaseType::operator=(rhs);
return *this;
}
template<typename DataType >
reference Nektar::Array< ThreeD, DataType >::operator[] ( index  i)
inline

Definition at line 696 of file SharedArray.hpp.

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