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

FArray2D: Fortran-Compatible 2D Array. More...

#include <FArray2D.hh>

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

List of all members.

Public Types

typedef Super::Base Base
typedef Base::Section Section
typedef Super::IR SIR
typedef DynamicIndexRange 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
typedef FArrayInitializer< T,
ObjexxFCL::FArray2D
Initializer
typedef Initializer::function_type InitializerFunction

Public Member Functions

 FArray2D ()
 Default Constructor.
 FArray2D (FArray2D const &a)
 Copy Constructor.
template<typename U >
 FArray2D (FArray2D< U > const &a)
 Copy Constructor Template.
template<typename U >
 FArray2D (FArray2< U > const &a)
 Super Constructor Template.
 FArray2D (IR const &I1_a, IR const &I2_a)
 IndexRange Constructor.
 FArray2D (IR const &I1_a, IR const &I2_a, T const &t)
 IndexRange + Initializer Value Constructor.
 FArray2D (IR const &I1_a, IR const &I2_a, InitializerFunction const &function_a)
 IndexRange + Initializer Function Constructor.
template<typename U >
 FArray2D (FArray2< U > const &a, IR const &I1_a, IR const &I2_a)
 Super + IndexRange Constructor Template.
template<typename U >
 FArray2D (FArray2< U > const &a, IR const &I1_a, IR const &I2_a, T const &t)
 Super + IndexRange + Fill Value Constructor Template.
virtual ~FArray2D ()
 Destructor.
FArray2Doperator= (FArray2D const &a)
 Copy Assignment.
FArray2Doperator= (Super const &a)
 Super Assignment.
template<typename U >
FArray2Doperator= (FArray2< U > const &a)
 Super Assignment Template.
template<typename U >
FArray2Doperator+= (FArray2< U > const &a)
 += Array Template
template<typename U >
FArray2Doperator*= (FArray2< U > const &a)
 *= Array Template
template<typename U >
FArray2Doperator-= (FArray2< U > const &a)
 -= Array Template
FArray2Doperator= (T const &t)
 = Value
FArray2Doperator+= (T const &t)
 += Value
FArray2Doperator-= (T const &t)
 -= Value
FArray2Doperator*= (T const &t)
 *= Value
FArray2Doperator/= (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 )
size_type index (int const i1, int const i2) const
 Linear Index.
T const & operator[] (size_type const i) const
 array[ i ] const: Linear Subscript
T & operator[] (size_type const i)
 array[ i ]: Linear Subscript
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.
FArray2Dclear ()
 Clear.
FArray2Ddimension (IR const &I1_a, IR const &I2_a)
 Dimension by IndexRanges.
FArray2Ddimension (IR const &I1_a, IR const &I2_a, T const &t)
 Dimension by IndexRanges + Initializer Value.
FArray2Ddimension (IR const &I1_a, IR const &I2_a, InitializerFunction const &function_a)
 Dimension by IndexRanges + Initializer Function.
template<typename U >
FArray2Ddimension (FArray2< U > const &a)
 Dimension by Array Template.
template<typename U >
FArray2Ddimension (FArray2< U > const &a, T const &t)
 Dimension by Array + Initializer Value Template.
template<typename U >
FArray2Ddimension (FArray2< U > const &a, InitializerFunction const &function_a)
 Dimension by Array + Initializer Function Template.
FArray2Dredimension (IR const &I1_a, IR const &I2_a)
 Data-Preserving Redimension by IndexRanges.
FArray2Dredimension (IR const &I1_a, IR const &I2_a, T const &t)
 Data-Preserving Redimension by IndexRanges + Fill Value.
template<typename U >
FArray2Dredimension (FArray2< U > const &a)
 Data-Preserving Redimension by Array Template.
template<typename U >
FArray2Dredimension (FArray2< U > const &a, T const &t)
 Data-Preserving Redimension by Array + Fill Value Template.
FArray2Dinitializer (T const &t)
 Set Initializer Value.
FArray2Dinitializer (InitializerFunction const &function_a)
 Set Initializer Function.
FArray2Dinitializer_clear ()
 Clear Initializer.
FArray2Dinitialize ()
 Initialize.
FArray2Dswap (FArray2D &v)
 Swap.
void update ()
 Update.
void destructed (Subject const &)
 Update for Destruction of a Subject.

Static Public Member Functions

static FArray2D diag (IR const &I_a, T const &d)
 Diagonal Matrix Named Constructor.
static FArray2D identity (IR const &I_a)
 Identity Matrix Named Constructor.

Protected Member Functions

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

Friends

class FArray2D
class FArray2P< T >
class FArray2A< T >
void swap (FArray2D &a, FArray2D &b)
 Swap.
FArray2D operator- (Super const &a)
 -Array
FArray2D operator+ (Super const &a, Super const &b)
 Array + Array.
FArray2D operator- (Super const &a, Super const &b)
 Array - Array.
FArray2D operator+ (Super const &a, T const &t)
 Array + Value.
FArray2D operator+ (T const &t, Super const &a)
 Value + Array.
FArray2D operator- (Super const &a, T const &t)
 Array - Value.
FArray2D operator- (T const &t, Super const &a)
 Value - Array.
FArray2D operator* (Super const &a, T const &t)
 Array * Value.
FArray2D operator* (T const &t, Super const &a)
 Value * Array.
FArray2D operator/ (Super const &a, T const &t)
 Array / Value.
FArray2D transposed (Super const &a)
 Transposed.

Detailed Description

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

FArray2D: Fortran-Compatible 2D Array.


Member Typedef Documentation

template<typename T>
typedef Super::Base ObjexxFCL::FArray2D< 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 DynamicIndexRange ObjexxFCL::FArray2D< T >::IR

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.

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

Reimplemented from ObjexxFCL::FArray2< T >.

Reimplemented from ObjexxFCL::FArray2< T >.


Constructor & Destructor Documentation

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

Default Constructor.

Referenced by ObjexxFCL::FArray2D< double >::redimension().

template<typename T>
ObjexxFCL::FArray2D< T >::FArray2D ( FArray2D< T > const &  a) [inline]

Copy Constructor.

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

Copy Constructor Template.

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

Super Constructor Template.

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

IndexRange Constructor.

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

IndexRange + Initializer Value Constructor.

template<typename T>
ObjexxFCL::FArray2D< T >::FArray2D ( IR const &  I1_a,
IR const &  I2_a,
InitializerFunction const &  function_a 
) [inline]

IndexRange + Initializer Function Constructor.

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

Super + IndexRange Constructor Template.

template<typename T>
template<typename U >
ObjexxFCL::FArray2D< T >::FArray2D ( FArray2< U > const &  a,
IR const &  I1_a,
IR const &  I2_a,
T const &  t 
) [inline]

Super + IndexRange + Fill Value Constructor Template.

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

Destructor.


Member Function Documentation

template<typename T>
Section const ObjexxFCL::FArray2D< T >::a ( int const  i1,
int const  i2 
) const [inline]

Section Starting at array( i1, i2 )

Reimplemented from ObjexxFCL::FArray2< T >.

Referenced by ObjexxFCL::FArray2D< double >::FArray2D().

template<typename T>
FArray2D& ObjexxFCL::FArray2D< T >::clear ( ) [inline, virtual]

Clear.

Reimplemented from ObjexxFCL::FArray2< T >.

template<typename T>
bool ObjexxFCL::FArray2D< T >::contains ( int const  i1,
int const  i2 
) const [inline, virtual]

Contains Indexed Element?

Reimplemented from ObjexxFCL::FArray2< T >.

template<typename T>
void ObjexxFCL::FArray2D< T >::destructed ( Subject const &  ) [inline, virtual]

Update for Destruction of a Subject.

Implements ObjexxFCL::Observer.

template<typename T>
static FArray2D ObjexxFCL::FArray2D< T >::diag ( IR const &  I_a,
T const &  d 
) [inline, static]

Diagonal Matrix Named Constructor.

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

Dimension by IndexRanges + Initializer Value.

template<typename T>
FArray2D& ObjexxFCL::FArray2D< T >::dimension ( IR const &  I1_a,
IR const &  I2_a,
InitializerFunction const &  function_a 
) [inline]

Dimension by IndexRanges + Initializer Function.

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

Dimension by Array Template.

template<typename T>
template<typename U >
FArray2D& ObjexxFCL::FArray2D< T >::dimension ( FArray2< U > const &  a,
T const &  t 
) [inline]

Dimension by Array + Initializer Value Template.

template<typename T>
template<typename U >
FArray2D& ObjexxFCL::FArray2D< T >::dimension ( FArray2< U > const &  a,
InitializerFunction const &  function_a 
) [inline]

Dimension by Array + Initializer Function Template.

template<typename T>
FArray2D& ObjexxFCL::FArray2D< T >::dimension ( IR const &  I1_a,
IR const &  I2_a 
) [inline]
template<typename T>
void ObjexxFCL::FArray2D< T >::dimension_assign ( SIR const &  I1_a,
SIR const &  I2_a 
) [inline, protected, virtual]

Dimension by IndexRanges.

Implements ObjexxFCL::FArray2< T >.

template<typename T>
bool ObjexxFCL::FArray2D< T >::dimensions_initialized ( ) const [inline, virtual]
template<typename T>
IR const& ObjexxFCL::FArray2D< T >::I1 ( ) const [inline, virtual]
template<typename T>
IR const& ObjexxFCL::FArray2D< T >::I2 ( ) const [inline, virtual]
template<typename T>
static FArray2D ObjexxFCL::FArray2D< T >::identity ( IR const &  I_a) [inline, static]

Identity Matrix Named Constructor.

template<typename T>
size_type ObjexxFCL::FArray2D< T >::index ( int const  i1,
int const  i2 
) const [inline]

Linear Index.

Reimplemented from ObjexxFCL::FArray2< T >.

template<typename T>
FArray2D& ObjexxFCL::FArray2D< T >::initialize ( ) [inline]
template<typename T>
FArray2D& ObjexxFCL::FArray2D< T >::initializer ( T const &  t) [inline]

Set Initializer Value.

template<typename T>
FArray2D& ObjexxFCL::FArray2D< T >::initializer ( InitializerFunction const &  function_a) [inline]

Set Initializer Function.

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

Initializer Active?

Implements ObjexxFCL::FArray< T >.

template<typename T>
FArray2D& ObjexxFCL::FArray2D< T >::initializer_clear ( ) [inline]

Clear Initializer.

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

Lower Index of Dimension 1.

Implements ObjexxFCL::FArray2< T >.

Referenced by average_score_components().

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

Lower Index of Dimension 2.

Implements ObjexxFCL::FArray2< T >.

Referenced by average_score_components().

template<typename T>
T const& ObjexxFCL::FArray2D< T >::operator() ( int const  i1,
int const  i2 
) const [inline]

array( i1, i2 ) const

Reimplemented from ObjexxFCL::FArray2< T >.

Referenced by ObjexxFCL::FArray2D< double >::FArray2D().

template<typename T>
T& ObjexxFCL::FArray2D< T >::operator() ( int const  i1,
int const  i2 
) [inline]

array( i1, i2 )

Reimplemented from ObjexxFCL::FArray2< T >.

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

*= Value

Reimplemented from ObjexxFCL::FArray2< T >.

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

*= Array Template

Reimplemented from ObjexxFCL::FArray2< T >.

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

+= Value

Reimplemented from ObjexxFCL::FArray2< T >.

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

+= Array Template

Reimplemented from ObjexxFCL::FArray2< T >.

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

-= Array Template

Reimplemented from ObjexxFCL::FArray2< T >.

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

-= Value

Reimplemented from ObjexxFCL::FArray2< T >.

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

/= Value

Reimplemented from ObjexxFCL::FArray2< T >.

template<typename T>
FArray2D& ObjexxFCL::FArray2D< T >::operator= ( Super const &  a) [inline]

Super Assignment.

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

= Value

Reimplemented from ObjexxFCL::FArray2< T >.

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

Super Assignment Template.

Reimplemented from ObjexxFCL::FArray2< T >.

template<typename T>
FArray2D& ObjexxFCL::FArray2D< T >::operator= ( FArray2D< T > const &  a) [inline]

Copy Assignment.

template<typename T>
T& ObjexxFCL::FArray2D< T >::operator[] ( size_type const  i) [inline]

array[ i ]: Linear Subscript

Reimplemented from ObjexxFCL::FArray< T >.

template<typename T>
T const& ObjexxFCL::FArray2D< T >::operator[] ( size_type const  i) const [inline]

array[ i ] const: Linear Subscript

Reimplemented from ObjexxFCL::FArray< T >.

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

Data-Preserving Redimension by IndexRanges.

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

Data-Preserving Redimension by IndexRanges + Fill Value.

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

Data-Preserving Redimension by Array Template.

template<typename T>
template<typename U >
FArray2D& ObjexxFCL::FArray2D< T >::redimension ( FArray2< U > const &  a,
T const &  t 
) [inline]

Data-Preserving Redimension by Array + Fill Value Template.

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

Size of Dimension 2.

Implements ObjexxFCL::FArray2< T >.

template<typename T>
FArray2D& ObjexxFCL::FArray2D< T >::swap ( FArray2D< T > &  v) [inline]
template<typename T>
int ObjexxFCL::FArray2D< T >::u1 ( ) const [inline, virtual]

Upper Index of Dimension 1.

Implements ObjexxFCL::FArray2< T >.

Referenced by average_score_components().

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

Upper Index of Dimension 2.

Implements ObjexxFCL::FArray2< T >.

Referenced by average_score_components().

template<typename T>
void ObjexxFCL::FArray2D< T >::update ( ) [inline, virtual]

Update.

Implements ObjexxFCL::Observer.


Friends And Related Function Documentation

template<typename T>
friend class FArray2A< T > [friend]
template<typename T>
friend class FArray2D [friend]

Reimplemented from ObjexxFCL::FArray2< T >.

template<typename T>
friend class FArray2P< T > [friend]
template<typename T>
FArray2D operator* ( Super const &  a,
T const &  t 
) [friend]

Array * Value.

template<typename T>
FArray2D operator* ( T const &  t,
Super const &  a 
) [friend]

Value * Array.

template<typename T>
FArray2D operator+ ( Super const &  a,
T const &  t 
) [friend]

Array + Value.

template<typename T>
FArray2D operator+ ( T const &  t,
Super const &  a 
) [friend]

Value + Array.

template<typename T>
FArray2D operator+ ( Super const &  a,
Super const &  b 
) [friend]

Array + Array.

template<typename T>
FArray2D operator- ( Super const &  a,
T const &  t 
) [friend]

Array - Value.

template<typename T>
FArray2D operator- ( T const &  t,
Super const &  a 
) [friend]

Value - Array.

template<typename T>
FArray2D operator- ( Super const &  a) [friend]

-Array

template<typename T>
FArray2D operator- ( Super const &  a,
Super const &  b 
) [friend]

Array - Array.

template<typename T>
FArray2D operator/ ( Super const &  a,
T const &  t 
) [friend]

Array / Value.

template<typename T>
void swap ( FArray2D< T > &  a,
FArray2D< T > &  b 
) [friend]

Swap.

template<typename T>
FArray2D transposed ( Super const &  a) [friend]

Transposed.


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