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

FArray1: Fortran-Compatible 1D Array Abstract Base Class. More...

#include <FArray1.hh>

Inheritance diagram for ObjexxFCL::FArray1< T >:
Inheritance graph
[legend]
Collaboration diagram for ObjexxFCL::FArray1< 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
typedef void iterator_category

Public Member Functions

virtual ~FArray1 ()
 Destructor.
FArray1operator= (FArray1 const &a)
 Copy Assignment.
template<typename U >
FArray1operator= (FArray1< U > const &a)
 Copy Assignment Template.
template<typename U >
FArray1operator+= (FArray1< U > const &a)
 += Array Template
template<typename U >
FArray1operator-= (FArray1< U > const &a)
 -= Array Template
FArray1operator= (T const &t)
 = Value
FArray1operator+= (T const &t)
 += Value
FArray1operator-= (T const &t)
 -= Value
FArray1operator*= (T const &t)
 *= Value
FArray1operator/= (T const &t)
 /= Value
T const & operator() (int const i) const
 array( i ) const
T & operator() (int const i)
 array( i )
Section const a (int const i) const
 Const Section Starting at array( i )
Section a (int const i)
 Section Starting at array( i )
size_type index (int const i) const
 Linear Index.
virtual bool contains (int const i) const
 Contains Indexed Element?
template<typename U >
bool equal_dimension (FArray1< U > const &a) const
 Equal Dimension?
virtual IR const & I1 () const =0
 IndexRange.
virtual int l1 () const =0
 Lower Index.
virtual int u1 () const =0
 Upper Index.
virtual size_type size1 () const =0
 Size.
virtual IR const & I () const =0
 IndexRange.
virtual int l () const =0
 Lower Index.
virtual int u () const =0
 Upper Index.
length () const
 Length.
length_squared () const
 Length Squared.
FArray1clear ()
 Clear.
FArray1to_default ()
 Assign Default Value to all Elements.
FArray1normalize ()
 Normalize to Unit Length.

Protected Types

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

Protected Member Functions

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

Friends

class FArray1
class FArray1D
class FArray1P
class FArray1A
class KeyFArray1D
bool operator== (FArray1 const &a, FArray1 const &b)
 FArray1 == FArray1.
bool operator!= (FArray1 const &a, FArray1 const &b)
 FArray1 != FArray1.
dot_product (FArray1 const &a, FArray1 const &b)
 Dot Product.
dot (FArray1 const &a, FArray1 const &b)
 Dot Product.
distance (FArray1 const &a, FArray1 const &b)
 Distance.
distance_squared (FArray1 const &a, FArray1 const &b)
 Distance Squared.

Detailed Description

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

FArray1: Fortran-Compatible 1D Array Abstract Base Class.


Member Typedef Documentation

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

Reimplemented from ObjexxFCL::FArray< T >.

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

Reimplemented from ObjexxFCL::FArray< T >.

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

Constructor & Destructor Documentation

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

Default Constructor.

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

Copy Constructor.

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

Copy Constructor Template.

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

Size Constructor.

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

Size + InitializerSentinel Constructor.

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

Default Proxy Constructor.

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

Copy Proxy Constructor.

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

Non-Const Copy Proxy Constructor.

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

Base Proxy Constructor.

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

Non-Const Base Proxy Constructor.

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

Section Proxy Constructor.

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

Non-Const Section Proxy Constructor.

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

Value Proxy Constructor.

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

Non-Const Value Proxy Constructor.

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

Destructor.


Member Function Documentation

template<typename T>
Section const ObjexxFCL::FArray1< T >::a ( int const  i) const [inline]
template<typename T>
Section ObjexxFCL::FArray1< T >::a ( int const  i) [inline]

Section Starting at array( i )

Reimplemented in ObjexxFCL::FArray1A< T >, and ObjexxFCL::FArray1P< T >.

template<typename T>
FArray1& ObjexxFCL::FArray1< T >::clear ( ) [inline, virtual]
template<typename T>
virtual bool ObjexxFCL::FArray1< T >::contains ( int const  i) const [inline, virtual]
template<typename T>
virtual void ObjexxFCL::FArray1< T >::dimension_assign ( IR const &  I_a) [protected, pure virtual]
template<typename T>
template<typename U >
bool ObjexxFCL::FArray1< T >::equal_dimension ( FArray1< U > const &  a) const [inline]
template<typename T>
virtual IR const& ObjexxFCL::FArray1< T >::I ( ) const [pure virtual]
template<typename T>
virtual IR const& ObjexxFCL::FArray1< T >::I1 ( ) const [pure virtual]
template<typename T>
size_type ObjexxFCL::FArray1< T >::index ( int const  i) const [inline]
template<typename T>
virtual int ObjexxFCL::FArray1< T >::l ( ) const [pure virtual]
template<typename T>
virtual int ObjexxFCL::FArray1< T >::l1 ( ) const [pure virtual]
template<typename T>
T ObjexxFCL::FArray1< T >::length ( ) const [inline]
template<typename T>
T ObjexxFCL::FArray1< T >::length_squared ( ) const [inline]

Length Squared.

template<typename T>
FArray1& ObjexxFCL::FArray1< T >::normalize ( ) [inline]

Normalize to Unit Length.

template<typename T>
T& ObjexxFCL::FArray1< T >::operator() ( int const  i) [inline]
template<typename T>
T const& ObjexxFCL::FArray1< T >::operator() ( int const  i) const [inline]
template<typename T>
FArray1& ObjexxFCL::FArray1< T >::operator*= ( T const &  t) [inline]
template<typename T>
template<typename U >
FArray1& ObjexxFCL::FArray1< T >::operator+= ( FArray1< U > const &  a) [inline]
template<typename T>
FArray1& ObjexxFCL::FArray1< T >::operator+= ( T const &  t) [inline]
template<typename T>
template<typename U >
FArray1& ObjexxFCL::FArray1< T >::operator-= ( FArray1< U > const &  a) [inline]
template<typename T>
FArray1& ObjexxFCL::FArray1< T >::operator-= ( T const &  t) [inline]
template<typename T>
FArray1& ObjexxFCL::FArray1< T >::operator/= ( T const &  t) [inline]
template<typename T>
template<typename U >
FArray1& ObjexxFCL::FArray1< T >::operator= ( FArray1< U > const &  a) [inline]
template<typename T>
FArray1& ObjexxFCL::FArray1< T >::operator= ( FArray1< T > const &  a) [inline]
template<typename T>
FArray1& ObjexxFCL::FArray1< T >::operator= ( T const &  t) [inline]
template<typename T>
virtual size_type ObjexxFCL::FArray1< T >::size1 ( ) const [pure virtual]
template<typename T>
void ObjexxFCL::FArray1< T >::swap1DB ( FArray1< T > &  v) [inline, protected]
template<typename T>
FArray1& ObjexxFCL::FArray1< T >::to_default ( ) [inline, virtual]

Assign Default Value to all Elements.

Reimplemented from ObjexxFCL::FArray< T >.

template<typename T>
virtual int ObjexxFCL::FArray1< T >::u ( ) const [pure virtual]
template<typename T>
virtual int ObjexxFCL::FArray1< T >::u1 ( ) const [pure virtual]

Friends And Related Function Documentation

template<typename T>
T distance ( FArray1< T > const &  a,
FArray1< T > const &  b 
) [friend]

Distance.

template<typename T>
T distance_squared ( FArray1< T > const &  a,
FArray1< T > const &  b 
) [friend]

Distance Squared.

template<typename T>
T dot ( FArray1< T > const &  a,
FArray1< T > const &  b 
) [friend]

Dot Product.

template<typename T>
T dot_product ( FArray1< T > const &  a,
FArray1< T > const &  b 
) [friend]

Dot Product.

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

Reimplemented in ObjexxFCL::KeyFArray1D< T >.

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

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