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

KeyFArray1D: Key-Access Fortran-Compatible 1D Array. More...

#include <KeyFArray1D.hh>

Inheritance diagram for ObjexxFCL::KeyFArray1D< T >:
Inheritance graph
[legend]
Collaboration diagram for ObjexxFCL::KeyFArray1D< 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::KeyFArray1D
Initializer
typedef Initializer::function_type InitializerFunction

Public Member Functions

 KeyFArray1D ()
 Default Constructor.
 KeyFArray1D (KeyFArray1D const &a)
 Copy Constructor.
template<typename U >
 KeyFArray1D (KeyFArray1D< U > const &a)
 Copy Constructor Template.
template<typename U >
 KeyFArray1D (FArray1< U > const &a)
 Super Constructor Template.
 KeyFArray1D (IR const &I_a)
 IndexRange Constructor.
 KeyFArray1D (IR const &I_a, T const &t)
 IndexRange + Initializer Value Constructor.
 KeyFArray1D (IR const &I_a, InitializerFunction const &function_a)
 IndexRange + Initializer Function Constructor.
template<typename U >
 KeyFArray1D (FArray1< U > const &a, IR const &I_a)
 Super + IndexRange Constructor Template.
template<typename U >
 KeyFArray1D (FArray1< U > const &a, IR const &I_a, T const &t)
 Super + IndexRange + Fill Value Constructor Template.
virtual ~KeyFArray1D ()
 Destructor.
KeyFArray1Doperator= (KeyFArray1D const &a)
 Copy Assignment.
KeyFArray1Doperator= (Super const &a)
 Super Assignment.
template<typename U >
KeyFArray1Doperator= (FArray1< U > const &a)
 Super Assignment Template.
template<typename U >
KeyFArray1Doperator+= (FArray1< U > const &a)
 += Array Template
template<typename U >
KeyFArray1Doperator-= (FArray1< U > const &a)
 -= Array Template
KeyFArray1Doperator= (T const &t)
 = Value
KeyFArray1Doperator+= (T const &t)
 += Value
KeyFArray1Doperator-= (T const &t)
 -= Value
KeyFArray1Doperator*= (T const &t)
 *= Value
KeyFArray1Doperator/= (T const &t)
 /= Value
template<typename K >
T const & operator() (K const &i) const
 array( i ) const
template<typename K >
T & operator() (K const &i)
 array( i )
template<typename K >
Section const a (K const &i) const
 Section Starting at array( i )
template<typename K >
size_type index (K const &i) 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?
template<typename K >
bool contains (K const &i) const
 Contains Indexed Element?
bool initializer_active () const
 Initializer Active?
IR const & I1 () const
 IndexRange.
int l1 () const
 Lower Index.
int u1 () const
 Upper Index.
size_type size1 () const
 Size.
IR const & I () const
 IndexRange.
int l () const
 Lower Index.
int u () const
 Upper Index.
KeyFArray1Dclear ()
 Clear.
KeyFArray1Ddimension (IR const &I_a)
 Dimension by IndexRange.
KeyFArray1Ddimension (IR const &I_a, T const &t)
 Dimension by IndexRange + Initializer Value.
KeyFArray1Ddimension (IR const &I_a, InitializerFunction const &function_a)
 Dimension by IndexRange + Initializer Function.
template<typename U >
KeyFArray1Ddimension (FArray1< U > const &a)
 Dimension by Array Template.
template<typename U >
KeyFArray1Ddimension (FArray1< U > const &a, T const &t)
 Dimension by Array + Initializer Value Template.
template<typename U >
KeyFArray1Ddimension (FArray1< U > const &a, InitializerFunction const &function_a)
 Dimension by Array + Initializer Function Template.
KeyFArray1Dredimension (IR const &I_a)
 Data-Preserving Redimension by IndexRange.
KeyFArray1Dredimension (IR const &I_a, T const &t)
 Data-Preserving Redimension by IndexRange + Fill Value.
template<typename U >
KeyFArray1Dredimension (FArray1< U > const &a)
 Data-Preserving Redimension by Array Template.
template<typename U >
KeyFArray1Dredimension (FArray1< U > const &a, T const &t)
 Data-Preserving Redimension by Array + Fill Value Template.
KeyFArray1Dinitializer (T const &t)
 Set Initializer Value.
KeyFArray1Dinitializer (InitializerFunction const &function_a)
 Set Initializer Function.
KeyFArray1Dinitializer_clear ()
 Clear Initializer.
KeyFArray1Dinitialize ()
 Initialize.
KeyFArray1Dswap (KeyFArray1D &v)
 Swap.
void update ()
 Update.
void destructed (Subject const &)
 Update for Destruction of a Subject.

Protected Member Functions

void dimension_assign (SIR const &I_a)
 Dimension by IndexRanges.

Friends

class KeyFArray1D
class FArray1D< T >
class FArray1P< T >
class FArray1A< T >
void swap (KeyFArray1D &a, KeyFArray1D &b)
 Swap.
KeyFArray1D operator- (KeyFArray1D const &a)
 -Array
KeyFArray1D operator+ (KeyFArray1D const &a, KeyFArray1D const &b)
 Array + Array.
KeyFArray1D operator- (KeyFArray1D const &a, KeyFArray1D const &b)
 Array - Array.
KeyFArray1D operator+ (KeyFArray1D const &a, T const &t)
 Array + Value.
KeyFArray1D operator+ (T const &t, KeyFArray1D const &a)
 Value + Array.
KeyFArray1D operator- (KeyFArray1D const &a, T const &t)
 Array - Value.
KeyFArray1D operator- (T const &t, KeyFArray1D const &a)
 Value - Array.
KeyFArray1D operator* (KeyFArray1D const &a, T const &t)
 Array * Value.
KeyFArray1D operator* (T const &t, KeyFArray1D const &a)
 Value * Array.
KeyFArray1D operator/ (KeyFArray1D const &a, T const &t)
 Array / Value.
KeyFArray1D cross_product (Super const &a, Super const &b)
 Cross Product of Two 3-Tuple Vectors.
KeyFArray1D cross (Super const &a, Super const &b)
 Cross Product of Two 3-Tuple Vectors.

Detailed Description

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

KeyFArray1D: Key-Access Fortran-Compatible 1D Array.


Member Typedef Documentation

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

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

template<typename T>
typedef DynamicIndexRange ObjexxFCL::KeyFArray1D< T >::IR

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

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

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.

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

Reimplemented from ObjexxFCL::FArray1< T >.

Reimplemented from ObjexxFCL::FArray1< T >.


Constructor & Destructor Documentation

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

Default Constructor.

Referenced by ObjexxFCL::KeyFArray1D< T >::redimension().

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

Copy Constructor.

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

Copy Constructor Template.

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

Super Constructor Template.

template<typename T>
ObjexxFCL::KeyFArray1D< T >::KeyFArray1D ( IR const &  I_a) [inline, explicit]

IndexRange Constructor.

template<typename T>
ObjexxFCL::KeyFArray1D< T >::KeyFArray1D ( IR const &  I_a,
T const &  t 
) [inline]

IndexRange + Initializer Value Constructor.

References ObjexxFCL::KeyFArray1D< T >::initialize().

template<typename T>
ObjexxFCL::KeyFArray1D< T >::KeyFArray1D ( IR const &  I_a,
InitializerFunction const &  function_a 
) [inline]

IndexRange + Initializer Function Constructor.

References ObjexxFCL::KeyFArray1D< T >::initialize().

template<typename T>
template<typename U >
ObjexxFCL::KeyFArray1D< T >::KeyFArray1D ( FArray1< U > const &  a,
IR const &  I_a 
) [inline]
template<typename T>
template<typename U >
ObjexxFCL::KeyFArray1D< T >::KeyFArray1D ( FArray1< U > const &  a,
IR const &  I_a,
T const &  t 
) [inline]
template<typename T>
virtual ObjexxFCL::KeyFArray1D< T >::~KeyFArray1D ( ) [inline, virtual]

Destructor.


Member Function Documentation

template<typename T>
template<typename K >
Section const ObjexxFCL::KeyFArray1D< T >::a ( K const &  i) const [inline]
template<typename T>
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::clear ( ) [inline, virtual]
template<typename T>
template<typename K >
bool ObjexxFCL::KeyFArray1D< T >::contains ( K const &  i) const [inline]

Contains Indexed Element?

References ObjexxFCL::DynamicIndexRange::contains().

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

Update for Destruction of a Subject.

Implements ObjexxFCL::Observer.

template<typename T>
template<typename U >
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::dimension ( FArray1< U > const &  a,
T const &  t 
) [inline]
template<typename T>
template<typename U >
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::dimension ( FArray1< U > const &  a,
InitializerFunction const &  function_a 
) [inline]
template<typename T>
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::dimension ( IR const &  I_a) [inline]
template<typename T>
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::dimension ( IR const &  I_a,
T const &  t 
) [inline]
template<typename T>
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::dimension ( IR const &  I_a,
InitializerFunction const &  function_a 
) [inline]
template<typename T>
template<typename U >
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::dimension ( FArray1< U > const &  a) [inline]
template<typename T>
void ObjexxFCL::KeyFArray1D< T >::dimension_assign ( SIR const &  I_a) [inline, protected, virtual]
template<typename T>
bool ObjexxFCL::KeyFArray1D< T >::dimensions_initialized ( ) const [inline, virtual]
template<typename T>
IR const& ObjexxFCL::KeyFArray1D< T >::I ( ) const [inline, virtual]
template<typename T>
IR const& ObjexxFCL::KeyFArray1D< T >::I1 ( ) const [inline, virtual]
template<typename T>
template<typename K >
size_type ObjexxFCL::KeyFArray1D< T >::index ( K const &  i) const [inline]
template<typename T>
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::initialize ( ) [inline]
template<typename T>
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::initializer ( T const &  t) [inline]

Set Initializer Value.

References sd::t.

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

Set Initializer Function.

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

Clear Initializer.

References ObjexxFCL::FArrayInitializer< T, Array >::clear().

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

Lower Index.

Implements ObjexxFCL::FArray1< T >.

References ObjexxFCL::DynamicIndexRange::l().

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

Lower Index.

Implements ObjexxFCL::FArray1< T >.

References ObjexxFCL::DynamicIndexRange::l().

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

*= Value

Reimplemented from ObjexxFCL::FArray1< T >.

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

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

+= Array Template

Reimplemented from ObjexxFCL::FArray1< T >.

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

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

+= Value

Reimplemented from ObjexxFCL::FArray1< T >.

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

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

-= Array Template

Reimplemented from ObjexxFCL::FArray1< T >.

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

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

-= Value

Reimplemented from ObjexxFCL::FArray1< T >.

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

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

/= Value

Reimplemented from ObjexxFCL::FArray1< T >.

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

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

= Value

Reimplemented from ObjexxFCL::FArray1< T >.

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

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

array[ i ]: Linear Subscript

Reimplemented from ObjexxFCL::FArray< T >.

References ObjexxFCL::FArray< T >::array_, color_pdb::i, and ObjexxFCL::FArray< T >::size_.

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

array[ i ] const: Linear Subscript

Reimplemented from ObjexxFCL::FArray< T >.

References ObjexxFCL::FArray< T >::array_, color_pdb::i, and ObjexxFCL::FArray< T >::size_.

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

Data-Preserving Redimension by Array + Fill Value Template.

References ObjexxFCL::FArray1< T >::I(), ObjexxFCL::KeyFArray1D< T >::KeyFArray1D(), ObjexxFCL::KeyFArray1D< T >::swap(), and sd::t.

template<typename T>
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::redimension ( IR const &  I_a,
T const &  t 
) [inline]

Data-Preserving Redimension by IndexRange + Fill Value.

References ObjexxFCL::KeyFArray1D< T >::KeyFArray1D().

template<typename T>
template<typename U >
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::redimension ( FArray1< U > const &  a) [inline]
template<typename T>
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::redimension ( IR const &  I_a) [inline]

Data-Preserving Redimension by IndexRange.

References ObjexxFCL::KeyFArray1D< T >::KeyFArray1D().

template<typename T>
size_type ObjexxFCL::KeyFArray1D< T >::size1 ( ) const [inline, virtual]
template<typename T>
KeyFArray1D& ObjexxFCL::KeyFArray1D< T >::swap ( KeyFArray1D< T > &  v) [inline]
template<typename T>
int ObjexxFCL::KeyFArray1D< T >::u ( ) const [inline, virtual]

Upper Index.

Implements ObjexxFCL::FArray1< T >.

References ObjexxFCL::DynamicIndexRange::u().

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

Upper Index.

Implements ObjexxFCL::FArray1< T >.

References ObjexxFCL::DynamicIndexRange::u().

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

Friends And Related Function Documentation

template<typename T>
KeyFArray1D cross ( Super const &  a,
Super const &  b 
) [friend]

Cross Product of Two 3-Tuple Vectors.

template<typename T>
KeyFArray1D cross_product ( Super const &  a,
Super const &  b 
) [friend]

Cross Product of Two 3-Tuple Vectors.

template<typename T>
friend class FArray1A< T > [friend]
template<typename T>
friend class FArray1D< T > [friend]
template<typename T>
friend class FArray1P< T > [friend]
template<typename T>
friend class KeyFArray1D [friend]

Reimplemented from ObjexxFCL::FArray1< T >.

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

Array * Value.

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

Value * Array.

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

Array + Value.

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

Value + Array.

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

Array + Array.

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

Value - Array.

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

-Array

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

Array - Array.

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

Array - Value.

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

Array / Value.

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

Swap.


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