Rosetta 3.3
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
ObjexxFCL::FArray3< T > Class Template Reference

FArray3: Fortran-Compatible 3D Array Abstract Base Class. More...

#include <FArray3.hh>

Inheritance diagram for ObjexxFCL::FArray3< T >:
Inheritance graph
[legend]
Collaboration diagram for ObjexxFCL::FArray3< T >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef Super::Base Base
typedef Base::Section Section
typedef Base::IR IR
typedef Base::value_type value_type
typedef Base::reference reference
typedef Base::const_reference const_reference
typedef Base::pointer pointer
typedef Base::const_pointer const_pointer
typedef Base::size_type size_type
typedef Base::difference_type difference_type
typedef Base::Value Value
typedef Base::Reference Reference
typedef Base::ConstReference ConstReference
typedef Base::Pointer Pointer
typedef Base::ConstPointer ConstPointer
typedef Base::Size Size
typedef Base::Difference Difference

Public Member Functions

virtual ~FArray3 ()
 Destructor.
FArray3operator= (FArray3 const &a)
 Copy Assignment.
template<typename U >
FArray3operator= (FArray3< U > const &a)
 Copy Assignment Template.
template<typename U >
FArray3operator+= (FArray3< U > const &a)
 += Array Template
template<typename U >
FArray3operator-= (FArray3< U > const &a)
 -= Array Template
FArray3operator= (T const &t)
 = Value
FArray3operator+= (T const &t)
 += Value
FArray3operator-= (T const &t)
 -= Value
FArray3operator*= (T const &t)
 *= Value
FArray3operator/= (T const &t)
 /= Value
T const & operator() (int const i1, int const i2, int const i3) const
 array( i1, i2, i3 ) const
T & operator() (int const i1, int const i2, int const i3)
 array( i1, i2, i3 )
Section const a (int const i1, int const i2, int const i3) const
 Const Section Starting at array( i1, i2, i3 )
Section a (int const i1, int const i2, int const i3)
 Section Starting at array( i1, i2, i3 )
size_type index (int const i1, int const i2, int const i3) const
 Linear Index.
virtual bool contains (int const i1, int const i2, int const i3) const
 Contains Indexed Element?
template<typename U >
bool equal_dimension (FArray3< U > const &a) const
 Equal Dimension?
virtual IR const & I1 () const =0
 IndexRange of Dimension 1.
virtual int l1 () const =0
 Lower Index of Dimension 1.
virtual int u1 () const =0
 Upper Index of Dimension 1.
size_type size1 () const
 Size of Dimension 1.
virtual IR const & I2 () const =0
 IndexRange of Dimension 2.
virtual int l2 () const =0
 Lower Index of Dimension 2.
virtual int u2 () const =0
 Upper Index of Dimension 2.
size_type size2 () const
 Size of Dimension 2.
virtual IR const & I3 () const =0
 IndexRange of Dimension 3.
virtual int l3 () const =0
 Lower Index of Dimension 3.
virtual int u3 () const =0
 Upper Index of Dimension 3.
virtual size_type size3 () const =0
 Size of Dimension 3.
FArray3clear ()
 Clear.
FArray3to_default ()
 Assign Default Value to all Elements.

Protected Types

typedef
internal::InitializerSentinel 
InitializerSentinel
typedef internal::ProxySentinel ProxySentinel

Protected Member Functions

 FArray3 ()
 Default Constructor.
 FArray3 (FArray3 const &a)
 Copy Constructor.
template<typename U >
 FArray3 (FArray3< U > const &a)
 Copy Constructor Template.
 FArray3 (size_type const size_a)
 Size Constructor.
 FArray3 (size_type const size_a, InitializerSentinel const &initialized)
 Size + InitializerSentinel Constructor.
 FArray3 (ProxySentinel const &proxy)
 Default Proxy Constructor.
 FArray3 (FArray3 const &a, ProxySentinel const &proxy)
 Copy Proxy Constructor.
 FArray3 (FArray3 &a, ProxySentinel const &proxy)
 Non-Const Copy Proxy Constructor.
 FArray3 (Base const &a, ProxySentinel const &proxy)
 Base Proxy Constructor.
 FArray3 (Base &a, ProxySentinel const &proxy)
 Non-Const Base Proxy Constructor.
 FArray3 (Section const &s, ProxySentinel const &proxy)
 Section Proxy Constructor.
 FArray3 (Section &s, ProxySentinel const &proxy)
 Non-Const Section Proxy Constructor.
 FArray3 (T const &t, ProxySentinel const &proxy)
 Value Proxy Constructor.
 FArray3 (T &t, ProxySentinel const &proxy)
 Non-Const Value Proxy Constructor.
virtual void dimension_assign (IR const &I1_a, IR const &I2_a, IR const &I3_a)=0
 Dimension by IndexRanges.
void swap3DB (FArray3 &v)
 Swap.

Protected Attributes

size_type s1_
 Dimension 1 size.
size_type s2_
 Dimension 2 size.

Friends

class FArray3
class FArray3D
class FArray3P
class FArray3A
class KeyFArray3D
bool operator== (FArray3 const &a, FArray3 const &b)
 FArray3 == FArray3.
bool operator!= (FArray3 const &a, FArray3 const &b)
 FArray3 != FArray3.

Detailed Description

template<typename T>
class ObjexxFCL::FArray3< T >

FArray3: Fortran-Compatible 3D Array Abstract Base Class.


Member Typedef Documentation

template<typename T>
typedef Super::Base ObjexxFCL::FArray3< T >::Base

Reimplemented from ObjexxFCL::FArray< T >.

template<typename T>
typedef Base::IR ObjexxFCL::FArray3< T >::IR
template<typename T>
typedef Base::Pointer ObjexxFCL::FArray3< T >::Pointer
template<typename T>
typedef Base::pointer ObjexxFCL::FArray3< T >::pointer
template<typename T>
typedef internal::ProxySentinel ObjexxFCL::FArray3< T >::ProxySentinel [protected]

Reimplemented from ObjexxFCL::FArray< T >.

template<typename T>
typedef Base::Section ObjexxFCL::FArray3< T >::Section
template<typename T>
typedef Base::Size ObjexxFCL::FArray3< T >::Size
template<typename T>
typedef Base::Value ObjexxFCL::FArray3< T >::Value

Constructor & Destructor Documentation

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( ) [inline, protected]

Default Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( FArray3< T > const &  a) [inline, protected]

Copy Constructor.

template<typename T>
template<typename U >
ObjexxFCL::FArray3< T >::FArray3 ( FArray3< U > const &  a) [inline, explicit, protected]

Copy Constructor Template.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( size_type const  size_a) [inline, explicit, protected]

Size Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( size_type const  size_a,
InitializerSentinel const &  initialized 
) [inline, protected]

Size + InitializerSentinel Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( ProxySentinel const &  proxy) [inline, protected]

Default Proxy Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( FArray3< T > const &  a,
ProxySentinel const &  proxy 
) [inline, protected]

Copy Proxy Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( FArray3< T > &  a,
ProxySentinel const &  proxy 
) [inline, protected]

Non-Const Copy Proxy Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( Base const &  a,
ProxySentinel const &  proxy 
) [inline, protected]

Base Proxy Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( Base a,
ProxySentinel const &  proxy 
) [inline, protected]

Non-Const Base Proxy Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( Section const &  s,
ProxySentinel const &  proxy 
) [inline, protected]

Section Proxy Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( Section s,
ProxySentinel const &  proxy 
) [inline, protected]

Non-Const Section Proxy Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( T const &  t,
ProxySentinel const &  proxy 
) [inline, protected]

Value Proxy Constructor.

template<typename T>
ObjexxFCL::FArray3< T >::FArray3 ( T &  t,
ProxySentinel const &  proxy 
) [inline, protected]

Non-Const Value Proxy Constructor.

template<typename T>
virtual ObjexxFCL::FArray3< T >::~FArray3 ( ) [inline, virtual]

Destructor.


Member Function Documentation

template<typename T>
Section const ObjexxFCL::FArray3< T >::a ( int const  i1,
int const  i2,
int const  i3 
) const [inline]
template<typename T>
Section ObjexxFCL::FArray3< T >::a ( int const  i1,
int const  i2,
int const  i3 
) [inline]
template<typename T>
FArray3& ObjexxFCL::FArray3< T >::clear ( ) [inline, virtual]
template<typename T>
virtual bool ObjexxFCL::FArray3< T >::contains ( int const  i1,
int const  i2,
int const  i3 
) const [inline, virtual]
template<typename T>
virtual void ObjexxFCL::FArray3< T >::dimension_assign ( IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [protected, pure virtual]
template<typename T>
template<typename U >
bool ObjexxFCL::FArray3< T >::equal_dimension ( FArray3< U > const &  a) const [inline]
template<typename T>
virtual IR const& ObjexxFCL::FArray3< T >::I1 ( ) const [pure virtual]
template<typename T>
virtual IR const& ObjexxFCL::FArray3< T >::I2 ( ) const [pure virtual]
template<typename T>
virtual IR const& ObjexxFCL::FArray3< T >::I3 ( ) const [pure virtual]
template<typename T>
size_type ObjexxFCL::FArray3< T >::index ( int const  i1,
int const  i2,
int const  i3 
) const [inline]
template<typename T>
virtual int ObjexxFCL::FArray3< T >::l1 ( ) const [pure virtual]
template<typename T>
virtual int ObjexxFCL::FArray3< T >::l2 ( ) const [pure virtual]
template<typename T>
virtual int ObjexxFCL::FArray3< T >::l3 ( ) const [pure virtual]
template<typename T>
T& ObjexxFCL::FArray3< T >::operator() ( int const  i1,
int const  i2,
int const  i3 
) [inline]
template<typename T>
T const& ObjexxFCL::FArray3< T >::operator() ( int const  i1,
int const  i2,
int const  i3 
) const [inline]
template<typename T>
FArray3& ObjexxFCL::FArray3< T >::operator*= ( T const &  t) [inline]
template<typename T>
template<typename U >
FArray3& ObjexxFCL::FArray3< T >::operator+= ( FArray3< U > const &  a) [inline]
template<typename T>
FArray3& ObjexxFCL::FArray3< T >::operator+= ( T const &  t) [inline]
template<typename T>
template<typename U >
FArray3& ObjexxFCL::FArray3< T >::operator-= ( FArray3< U > const &  a) [inline]
template<typename T>
FArray3& ObjexxFCL::FArray3< T >::operator-= ( T const &  t) [inline]
template<typename T>
FArray3& ObjexxFCL::FArray3< T >::operator/= ( T const &  t) [inline]
template<typename T>
template<typename U >
FArray3& ObjexxFCL::FArray3< T >::operator= ( FArray3< U > const &  a) [inline]
template<typename T>
FArray3& ObjexxFCL::FArray3< T >::operator= ( T const &  t) [inline]
template<typename T>
FArray3& ObjexxFCL::FArray3< T >::operator= ( FArray3< T > const &  a) [inline]
template<typename T>
size_type ObjexxFCL::FArray3< T >::size1 ( ) const [inline]

Size of Dimension 1.

References ObjexxFCL::FArray3< T >::s1_.

template<typename T>
size_type ObjexxFCL::FArray3< T >::size2 ( ) const [inline]

Size of Dimension 2.

References ObjexxFCL::FArray3< T >::s2_.

template<typename T>
virtual size_type ObjexxFCL::FArray3< T >::size3 ( ) const [pure virtual]
template<typename T>
void ObjexxFCL::FArray3< T >::swap3DB ( FArray3< T > &  v) [inline, protected]
template<typename T>
FArray3& ObjexxFCL::FArray3< T >::to_default ( ) [inline, virtual]

Assign Default Value to all Elements.

Reimplemented from ObjexxFCL::FArray< T >.

References ObjexxFCL::FArray< T >::to_default().

template<typename T>
virtual int ObjexxFCL::FArray3< T >::u1 ( ) const [pure virtual]
template<typename T>
virtual int ObjexxFCL::FArray3< T >::u2 ( ) const [pure virtual]
template<typename T>
virtual int ObjexxFCL::FArray3< T >::u3 ( ) const [pure virtual]

Friends And Related Function Documentation

template<typename T>
friend class FArray3 [friend]
template<typename T>
friend class FArray3A [friend]
template<typename T>
friend class FArray3D [friend]

Reimplemented in ObjexxFCL::FArray3D< T >.

template<typename T>
friend class FArray3P [friend]
template<typename T>
friend class KeyFArray3D [friend]

Reimplemented in ObjexxFCL::KeyFArray3D< T >.

template<typename T>
bool operator!= ( FArray3< T > const &  a,
FArray3< T > const &  b 
) [friend]
template<typename T>
bool operator== ( FArray3< T > const &  a,
FArray3< T > const &  b 
) [friend]

Member Data Documentation

template<typename T>
size_type ObjexxFCL::FArray3< T >::s1_ [protected]
template<typename T>
size_type ObjexxFCL::FArray3< T >::s2_ [protected]

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