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

FArray2A: Fortran-Compatible 2D Argument Array. More...

#include <FArray2A.hh>

Inheritance diagram for ObjexxFCL::FArray2A< T >:
Inheritance graph
[legend]
Collaboration diagram for ObjexxFCL::FArray2A< 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

 FArray2A ()
 Default Constructor.
 FArray2A (FArray2A const &a)
 Copy Constructor.
 FArray2A (FArray2A &a)
 Non-Const Copy Constructor.
 FArray2A (real_FArray const &a)
 Real Constructor.
 FArray2A (real_FArray &a)
 Non-Const Real Constructor.
 FArray2A (proxy_FArray const &a)
 Proxy Constructor.
 FArray2A (proxy_FArray &a)
 Non-Const Proxy Constructor.
 FArray2A (Super const &a)
 Super Constructor.
 FArray2A (Super &a)
 Non-Const Super Constructor.
 FArray2A (Base const &a)
 Base Constructor.
 FArray2A (Base &a)
 Non-Const Base Constructor.
 FArray2A (Section const &s)
 Section Constructor.
 FArray2A (Section &s)
 Non-Const Section Constructor.
 FArray2A (T const &t)
 Value Constructor.
 FArray2A (T &t)
 Non-Const Value Constructor.
 FArray2A (FArray2A const &a, IR const &I1_a, IR const &I2_a)
 Copy + IndexRange Constructor.
 FArray2A (FArray2A &a, IR const &I1_a, IR const &I2_a)
 Non-Const Copy + IndexRange Constructor.
 FArray2A (real_FArray const &a, IR const &I1_a, IR const &I2_a)
 Real + IndexRange Constructor.
 FArray2A (real_FArray &a, IR const &I1_a, IR const &I2_a)
 Non-Const Real + IndexRange Constructor.
 FArray2A (proxy_FArray const &a, IR const &I1_a, IR const &I2_a)
 Proxy + IndexRange Constructor.
 FArray2A (proxy_FArray &a, IR const &I1_a, IR const &I2_a)
 Non-Const Proxy + IndexRange Constructor.
 FArray2A (Super const &a, IR const &I1_a, IR const &I2_a)
 Super + IndexRange Constructor.
 FArray2A (Super &a, IR const &I1_a, IR const &I2_a)
 Non-Const Super + IndexRange Constructor.
 FArray2A (Base const &a, IR const &I1_a, IR const &I2_a)
 Base + IndexRange Constructor.
 FArray2A (Base &a, IR const &I1_a, IR const &I2_a)
 Non-Const Base + IndexRange Constructor.
 FArray2A (Section const &s, IR const &I1_a, IR const &I2_a)
 Section + IndexRange Constructor.
 FArray2A (Section &s, IR const &I1_a, IR const &I2_a)
 Non-Const Section + IndexRange Constructor.
 FArray2A (T const &t, IR const &I1_a, IR const &I2_a)
 Value + IndexRange Constructor.
 FArray2A (T &t, IR const &I1_a, IR const &I2_a)
 Non-Const Value + IndexRange Constructor.
virtual ~FArray2A ()
 Destructor.
FArray2Aoperator= (FArray2A const &a)
 Copy Assignment.
FArray2Aoperator= (Super const &a)
 Super Assignment.
template<typename U >
FArray2Aoperator= (FArray2< U > const &a)
 Super Assignment Template.
template<typename U >
FArray2Aoperator+= (FArray2< U > const &a)
 += Array Template
template<typename U >
FArray2Aoperator-= (FArray2< U > const &a)
 -= Array Template
template<typename U >
FArray2Aoperator*= (FArray2< U > const &a)
 *= Array Template
FArray2Aoperator= (T const &t)
 = Value
FArray2Aoperator+= (T const &t)
 += Value
FArray2Aoperator-= (T const &t)
 -= Value
FArray2Aoperator*= (T const &t)
 *= Value
FArray2Aoperator/= (T const &t)
 /= Value
T const & operator() (int const i1, int const i2) const
 array( i1, i2 ) const
T & operator() (int const i1, int const i2)
 array( i1, i2 )
Section const a (int const i1, int const i2) const
 Section Starting at array( i1, i2 )
Section a (int const i1, int const i2)
 Non-Const Section Starting at array( i1, i2 )
size_type index (int const i1, int const i2) const
 Linear Index.
bool dimensions_initialized () const
 Dimensions Initialized?
bool contains (int const i1, int const i2) 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.
size_type size2 () const
 Size of Dimension 2.
FArray2Aclear ()
 Clear.
FArray2A const & dim (IR const &I1_a, IR const &I2_a) const
 Dimension by IndexRanges Even if Const.
template<typename U >
FArray2A const & dim (FArray2< U > const &a) const
 Dimension by Array Even if Const.
FArray2Adimension (IR const &I1_a, IR const &I2_a)
 Dimension by IndexRange.
template<typename U >
FArray2Adimension (FArray2< U > const &a)
 Dimension by Array.
FArray2Aattach (FArray2A const &a)
 Attach to Argument Array.
FArray2Aattach (FArray2A &a)
 Attach to Non-Const Argument Array.
FArray2Aattach (real_FArray const &a)
 Attach to Real Array.
FArray2Aattach (real_FArray &a)
 Attach to Non-Const Real Array.
FArray2Aattach (proxy_FArray const &a)
 Attach to Proxy Array.
FArray2Aattach (proxy_FArray &a)
 Attach to Non-Const Proxy Array.
FArray2Aattach (Super const &a)
 Attach to Super Array.
FArray2Aattach (Super &a)
 Attach to Non-Const Super Array.
FArray2Aattach (Base const &a)
 Attach to Base Array.
FArray2Aattach (Base &a)
 Attach to Non-Const Base Array.
FArray2Aattach (Section const &s)
 Attach to Section.
FArray2Aattach (Section &s)
 Attach to Non-Const Section.
FArray2Aattach (T const &t)
 Attach to Value.
FArray2Aattach (T &t)
 Attach to Non-Const Value.
FArray2Adetach ()
 Detach from Source Array.

Protected Member Functions

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

Detailed Description

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

FArray2A: Fortran-Compatible 2D Argument Array.


Member Typedef Documentation

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

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.


Constructor & Destructor Documentation

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

Default Constructor.

template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( FArray2A< T > const &  a) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( FArray2A< T > &  a) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( real_FArray const &  a) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( real_FArray a) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( proxy_FArray const &  a) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( proxy_FArray a) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( Super const &  a) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( Super a) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( Base const &  a) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( Base a) [inline]

Non-Const Base Constructor.

References ObjexxFCL::FArray2< T >::s1_, and ObjexxFCL::FArray< T >::shift_set().

template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( Section const &  s) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( Section s) [inline]

Non-Const Section Constructor.

References ObjexxFCL::FArray2< T >::s1_, and ObjexxFCL::FArray< T >::shift_set().

template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( T const &  t) [inline]
template<typename T>
ObjexxFCL::FArray2A< T >::FArray2A ( T &  t) [inline]

Non-Const Value Constructor.

References ObjexxFCL::FArray2< T >::s1_, and ObjexxFCL::FArray< T >::shift_set().

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

Copy + IndexRange Constructor.

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

Non-Const Copy + IndexRange Constructor.

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

Real + IndexRange Constructor.

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

Non-Const Real + IndexRange Constructor.

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

Proxy + IndexRange Constructor.

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

Non-Const Proxy + IndexRange Constructor.

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

Super + IndexRange Constructor.

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

Non-Const Super + IndexRange Constructor.

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

Base + IndexRange Constructor.

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

Non-Const Base + IndexRange Constructor.

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

Section + IndexRange Constructor.

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

Non-Const Section + IndexRange Constructor.

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

Value + IndexRange Constructor.

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

Non-Const Value + IndexRange Constructor.

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

Destructor.


Member Function Documentation

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

Contains Indexed Element?

Reimplemented from ObjexxFCL::FArray2< T >.

References ObjexxFCL::IndexRange::contains().

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

Dimension by IndexRanges Even if Const.

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

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

Dimension by Array Even if Const.

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

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

Dimensions Initialized?

Implements ObjexxFCL::FArray< T >.

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

Linear Index.

Reimplemented from ObjexxFCL::FArray2< T >.

References ObjexxFCL::FArray2< T >::s1_, and ObjexxFCL::FArray< T >::shift_.

template<typename T>
bool ObjexxFCL::FArray2A< T >::initializer_active ( ) const [inline, virtual]

Initializer Active?

Implements ObjexxFCL::FArray< T >.

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

Lower Index of Dimension 1.

Implements ObjexxFCL::FArray2< T >.

References ObjexxFCL::StaticIndexRange::l().

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

Lower Index of Dimension 2.

Implements ObjexxFCL::FArray2< T >.

References ObjexxFCL::StaticIndexRange::l().

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

*= Value

Reimplemented from ObjexxFCL::FArray2< T >.

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

template<typename T>
template<typename U >
FArray2A& ObjexxFCL::FArray2A< T >::operator*= ( FArray2< U > const &  a) [inline]

*= Array Template

Reimplemented from ObjexxFCL::FArray2< T >.

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

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

+= Value

Reimplemented from ObjexxFCL::FArray2< T >.

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

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

+= Array Template

Reimplemented from ObjexxFCL::FArray2< T >.

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

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

-= Value

Reimplemented from ObjexxFCL::FArray2< T >.

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

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

-= Array Template

Reimplemented from ObjexxFCL::FArray2< T >.

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

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

/= Value

Reimplemented from ObjexxFCL::FArray2< T >.

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

template<typename T>
FArray2A& ObjexxFCL::FArray2A< T >::operator= ( Super const &  a) [inline]
template<typename T>
FArray2A& ObjexxFCL::FArray2A< T >::operator= ( FArray2A< T > const &  a) [inline]
template<typename T>
template<typename U >
FArray2A& ObjexxFCL::FArray2A< T >::operator= ( FArray2< U > const &  a) [inline]
template<typename T>
FArray2A& ObjexxFCL::FArray2A< T >::operator= ( T const &  t) [inline]

= Value

Reimplemented from ObjexxFCL::FArray2< T >.

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

template<typename T>
size_type ObjexxFCL::FArray2A< T >::size2 ( ) const [inline, virtual]
template<typename T>
int ObjexxFCL::FArray2A< T >::u1 ( ) const [inline, virtual]

Upper Index of Dimension 1.

Implements ObjexxFCL::FArray2< T >.

References ObjexxFCL::StaticIndexRange::u().

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

Upper Index of Dimension 2.

Implements ObjexxFCL::FArray2< 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