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

FArray3A: Fortran-Compatible 3D Argument Array. More...

#include <FArray3A.hh>

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

List of all members.

Public Types

typedef Super::Base Base
typedef Base::Section Section
typedef Super::IR SIR
typedef StaticIndexRange 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

 FArray3A ()
 Default Constructor.
 FArray3A (FArray3A const &a)
 Copy Constructor.
 FArray3A (FArray3A &a)
 Non-Const Copy Constructor.
 FArray3A (real_FArray const &a)
 Real Constructor.
 FArray3A (real_FArray &a)
 Non-Const Real Constructor.
 FArray3A (proxy_FArray const &a)
 Proxy Constructor.
 FArray3A (proxy_FArray &a)
 Non-Const Proxy Constructor.
 FArray3A (Super const &a)
 Super Constructor.
 FArray3A (Super &a)
 Non-Const Super Constructor.
 FArray3A (Base const &a)
 Base Constructor.
 FArray3A (Base &a)
 Non-Const Base Constructor.
 FArray3A (Section const &s)
 Section Constructor.
 FArray3A (Section &s)
 Non-Const Section Constructor.
 FArray3A (T const &t)
 Value Constructor.
 FArray3A (T &t)
 Non-Const Value Constructor.
 FArray3A (FArray3A const &a, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Copy + IndexRange Constructor.
 FArray3A (FArray3A &a, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Non-Const Copy + IndexRange Constructor.
 FArray3A (real_FArray const &a, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Real + IndexRange Constructor.
 FArray3A (real_FArray &a, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Non-Const Real + IndexRange Constructor.
 FArray3A (proxy_FArray const &a, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Proxy + IndexRange Constructor.
 FArray3A (proxy_FArray &a, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Non-Const Proxy + IndexRange Constructor.
 FArray3A (Super const &a, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Super + IndexRange Constructor.
 FArray3A (Super &a, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Non-Const Super + IndexRange Constructor.
 FArray3A (Base const &a, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Base + IndexRange Constructor.
 FArray3A (Base &a, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Non-Const Base + IndexRange Constructor.
 FArray3A (Section const &s, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Section + IndexRange Constructor.
 FArray3A (Section &s, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Non-Const Section + IndexRange Constructor.
 FArray3A (T const &t, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Value + IndexRange Constructor.
 FArray3A (T &t, IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Non-Const Value + IndexRange Constructor.
virtual ~FArray3A ()
 Destructor.
FArray3Aoperator= (FArray3A const &a)
 Copy Assignment.
FArray3Aoperator= (Super const &a)
 Super Assignment.
template<typename U >
FArray3Aoperator= (FArray3< U > const &a)
 Super Assignment Template.
template<typename U >
FArray3Aoperator+= (FArray3< U > const &a)
 += Array Template
template<typename U >
FArray3Aoperator-= (FArray3< U > const &a)
 -= Array Template
FArray3Aoperator= (T const &t)
 = Value
FArray3Aoperator+= (T const &t)
 += Value
FArray3Aoperator-= (T const &t)
 -= Value
FArray3Aoperator*= (T const &t)
 *= Value
FArray3Aoperator/= (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
 Section Starting at array( i1, i2, i3 )
Section a (int const i1, int const i2, int const i3)
 Non-Const Section Starting at array( i1, i2, i3 )
size_type index (int const i1, int const i2, int const i3) const
 Linear Index.
bool dimensions_initialized () const
 Dimensions Initialized?
bool contains (int const i1, int const i2, int const i3) const
 Contains Indexed Element?
bool initializer_active () const
 Initializer Active?
IR const & I1 () const
 IndexRange of Dimension 1.
int l1 () const
 Lower Index of Dimension 1.
int u1 () const
 Upper Index of Dimension 1.
IR const & I2 () const
 IndexRange of Dimension 2.
int l2 () const
 Lower Index of Dimension 2.
int u2 () const
 Upper Index of Dimension 2.
IR const & I3 () const
 IndexRange of Dimension 3.
int l3 () const
 Lower Index of Dimension 3.
int u3 () const
 Upper Index of Dimension 3.
size_type size3 () const
 Size of Dimension 3.
FArray3Aclear ()
 Clear.
FArray3A const & dim (IR const &I1_a, IR const &I2_a, IR const &I3_a) const
 Dimension by IndexRanges Even if Const.
template<typename U >
FArray3A const & dim (FArray3< U > const &a) const
 Dimension by Array Even if Const.
FArray3Adimension (IR const &I1_a, IR const &I2_a, IR const &I3_a)
 Dimension by IndexRange.
template<typename U >
FArray3Adimension (FArray3< U > const &a)
 Dimension by Array.
FArray3Aattach (FArray3A const &a)
 Attach to Argument Array.
FArray3Aattach (FArray3A &a)
 Attach to Non-Const Argument Array.
FArray3Aattach (real_FArray const &a)
 Attach to Real Array.
FArray3Aattach (real_FArray &a)
 Attach to Non-Const Real Array.
FArray3Aattach (proxy_FArray const &a)
 Attach to Proxy Array.
FArray3Aattach (proxy_FArray &a)
 Attach to Non-Const Proxy Array.
FArray3Aattach (Super const &a)
 Attach to Super Array.
FArray3Aattach (Super &a)
 Attach to Non-Const Super Array.
FArray3Aattach (Base const &a)
 Attach to Base Array.
FArray3Aattach (Base &a)
 Attach to Non-Const Base Array.
FArray3Aattach (Section const &s)
 Attach to Section.
FArray3Aattach (Section &s)
 Attach to Non-Const Section.
FArray3Aattach (T const &t)
 Attach to Value.
FArray3Aattach (T &t)
 Attach to Non-Const Value.
FArray3Adetach ()
 Detach from Source Array.

Protected Member Functions

void dimension_assign (SIR const &I1_a, SIR const &I2_a, SIR const &I3_a)
 Dimension by IndexRanges.

Detailed Description

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

FArray3A: Fortran-Compatible 3D Argument Array.


Member Typedef Documentation

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

Reimplemented from ObjexxFCL::FArray3< T >.

Reimplemented from ObjexxFCL::FArray3< T >.

Reimplemented from ObjexxFCL::FArray3< T >.

Reimplemented from ObjexxFCL::FArray3< T >.

Reimplemented from ObjexxFCL::FArray3< T >.

Reimplemented from ObjexxFCL::FArray3< T >.

Reimplemented from ObjexxFCL::FArray3< T >.

template<typename T >
typedef StaticIndexRange ObjexxFCL::FArray3A< T >::IR

Reimplemented from ObjexxFCL::FArray3< T >.

template<typename T >
typedef Base::pointer ObjexxFCL::FArray3A< T >::pointer

Reimplemented from ObjexxFCL::FArray3< T >.

template<typename T >
typedef Base::Pointer ObjexxFCL::FArray3A< T >::Pointer

Reimplemented from ObjexxFCL::FArray3< T >.

Reimplemented from ObjexxFCL::FArray3< T >.

Reimplemented from ObjexxFCL::FArray3< T >.

template<typename T >
typedef Base::Section ObjexxFCL::FArray3A< T >::Section

Reimplemented from ObjexxFCL::FArray3< T >.

template<typename T >
typedef Super::IR ObjexxFCL::FArray3A< T >::SIR
template<typename T >
typedef Base::Size ObjexxFCL::FArray3A< T >::Size

Reimplemented from ObjexxFCL::FArray3< T >.

Reimplemented from ObjexxFCL::FArray3< T >.

template<typename T >
typedef Base::Value ObjexxFCL::FArray3A< T >::Value

Reimplemented from ObjexxFCL::FArray3< T >.

Reimplemented from ObjexxFCL::FArray3< T >.


Constructor & Destructor Documentation

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( ) [inline]

Default Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( FArray3A< T > const &  a) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( FArray3A< T > &  a) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( real_FArray const &  a) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( real_FArray a) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( proxy_FArray const &  a) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( proxy_FArray a) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Super const &  a) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Super a) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Base const &  a) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Base a) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Section const &  s) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Section s) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( T const &  t) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( T &  t) [inline]
template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( FArray3A< T > const &  a,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Copy + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( FArray3A< T > &  a,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Non-Const Copy + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( real_FArray const &  a,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Real + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( real_FArray a,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Non-Const Real + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( proxy_FArray const &  a,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Proxy + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( proxy_FArray a,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Non-Const Proxy + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Super const &  a,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Super + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Super a,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Non-Const Super + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Base const &  a,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Base + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Base a,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Non-Const Base + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Section const &  s,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Section + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( Section s,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Non-Const Section + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( T const &  t,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Value + IndexRange Constructor.

template<typename T >
ObjexxFCL::FArray3A< T >::FArray3A ( T &  t,
IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]

Non-Const Value + IndexRange Constructor.

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

Destructor.


Member Function Documentation

template<typename T >
Section const ObjexxFCL::FArray3A< T >::a ( int const  i1,
int const  i2,
int const  i3 
) const [inline]
template<typename T >
Section ObjexxFCL::FArray3A< T >::a ( int const  i1,
int const  i2,
int const  i3 
) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( FArray3A< T > const &  a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( T &  t) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( FArray3A< T > &  a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( real_FArray const &  a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( real_FArray a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( Base a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( proxy_FArray const &  a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( proxy_FArray a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( Super const &  a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( Super a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( Base const &  a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( Section const &  s) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( Section s) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::attach ( T const &  t) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::clear ( ) [inline, virtual]
template<typename T >
bool ObjexxFCL::FArray3A< T >::contains ( int const  i1,
int const  i2,
int const  i3 
) const [inline, virtual]

Contains Indexed Element?

Reimplemented from ObjexxFCL::FArray3< T >.

References ObjexxFCL::IndexRange::contains().

template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::detach ( ) [inline]
template<typename T >
FArray3A const& ObjexxFCL::FArray3A< T >::dim ( IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) const [inline]

Dimension by IndexRanges Even if Const.

References ObjexxFCL::FArray3A< T >::dimension().

template<typename T >
template<typename U >
FArray3A const& ObjexxFCL::FArray3A< T >::dim ( FArray3< U > const &  a) const [inline]

Dimension by Array Even if Const.

References ObjexxFCL::FArray3A< T >::dimension().

template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::dimension ( IR const &  I1_a,
IR const &  I2_a,
IR const &  I3_a 
) [inline]
template<typename T >
template<typename U >
FArray3A& ObjexxFCL::FArray3A< T >::dimension ( FArray3< U > const &  a) [inline]
template<typename T >
void ObjexxFCL::FArray3A< T >::dimension_assign ( SIR const &  I1_a,
SIR const &  I2_a,
SIR const &  I3_a 
) [inline, protected, virtual]
template<typename T >
bool ObjexxFCL::FArray3A< T >::dimensions_initialized ( ) const [inline, virtual]

Dimensions Initialized?

Implements ObjexxFCL::FArray< T >.

template<typename T >
IR const& ObjexxFCL::FArray3A< T >::I1 ( ) const [inline, virtual]
template<typename T >
IR const& ObjexxFCL::FArray3A< T >::I2 ( ) const [inline, virtual]
template<typename T >
IR const& ObjexxFCL::FArray3A< T >::I3 ( ) const [inline, virtual]
template<typename T >
size_type ObjexxFCL::FArray3A< T >::index ( int const  i1,
int const  i2,
int const  i3 
) const [inline]
template<typename T >
bool ObjexxFCL::FArray3A< T >::initializer_active ( ) const [inline, virtual]

Initializer Active?

Implements ObjexxFCL::FArray< T >.

template<typename T >
int ObjexxFCL::FArray3A< T >::l1 ( ) const [inline, virtual]

Lower Index of Dimension 1.

Implements ObjexxFCL::FArray3< T >.

References ObjexxFCL::StaticIndexRange::l().

template<typename T >
int ObjexxFCL::FArray3A< T >::l2 ( ) const [inline, virtual]

Lower Index of Dimension 2.

Implements ObjexxFCL::FArray3< T >.

References ObjexxFCL::StaticIndexRange::l().

template<typename T >
int ObjexxFCL::FArray3A< T >::l3 ( ) const [inline, virtual]

Lower Index of Dimension 3.

Implements ObjexxFCL::FArray3< T >.

References ObjexxFCL::StaticIndexRange::l().

template<typename T >
T& ObjexxFCL::FArray3A< T >::operator() ( int const  i1,
int const  i2,
int const  i3 
) [inline]
template<typename T >
T const& ObjexxFCL::FArray3A< T >::operator() ( int const  i1,
int const  i2,
int const  i3 
) const [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::operator*= ( T const &  t) [inline]

*= Value

Reimplemented from ObjexxFCL::FArray3< T >.

References ObjexxFCL::FArray3< T >::operator*=().

template<typename T >
template<typename U >
FArray3A& ObjexxFCL::FArray3A< T >::operator+= ( FArray3< U > const &  a) [inline]

+= Array Template

Reimplemented from ObjexxFCL::FArray3< T >.

References ObjexxFCL::FArray3< T >::operator+=().

template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::operator+= ( T const &  t) [inline]

+= Value

Reimplemented from ObjexxFCL::FArray3< T >.

References ObjexxFCL::FArray3< T >::operator+=().

template<typename T >
template<typename U >
FArray3A& ObjexxFCL::FArray3A< T >::operator-= ( FArray3< U > const &  a) [inline]

-= Array Template

Reimplemented from ObjexxFCL::FArray3< T >.

References ObjexxFCL::FArray3< T >::operator-=().

template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::operator-= ( T const &  t) [inline]

-= Value

Reimplemented from ObjexxFCL::FArray3< T >.

References ObjexxFCL::FArray3< T >::operator-=().

template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::operator/= ( T const &  t) [inline]

/= Value

Reimplemented from ObjexxFCL::FArray3< T >.

References ObjexxFCL::FArray3< T >::operator/=().

template<typename T >
template<typename U >
FArray3A& ObjexxFCL::FArray3A< T >::operator= ( FArray3< U > const &  a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::operator= ( FArray3A< T > const &  a) [inline]
template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::operator= ( T const &  t) [inline]

= Value

Reimplemented from ObjexxFCL::FArray3< T >.

References ObjexxFCL::FArray3< T >::operator=().

template<typename T >
FArray3A& ObjexxFCL::FArray3A< T >::operator= ( Super const &  a) [inline]
template<typename T >
size_type ObjexxFCL::FArray3A< T >::size3 ( ) const [inline, virtual]
template<typename T >
int ObjexxFCL::FArray3A< T >::u1 ( ) const [inline, virtual]

Upper Index of Dimension 1.

Implements ObjexxFCL::FArray3< T >.

References ObjexxFCL::StaticIndexRange::u().

template<typename T >
int ObjexxFCL::FArray3A< T >::u2 ( ) const [inline, virtual]

Upper Index of Dimension 2.

Implements ObjexxFCL::FArray3< T >.

References ObjexxFCL::StaticIndexRange::u().

template<typename T >
int ObjexxFCL::FArray3A< T >::u3 ( ) const [inline, virtual]

Upper Index of Dimension 3.

Implements ObjexxFCL::FArray3< T >.

References ObjexxFCL::StaticIndexRange::u().


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