Rosetta 3.3
Public Types | Public Member Functions | Friends
ObjexxFCL::StaticIndexRange Class Reference

StaticIndexRange: Static Index Range. More...

#include <StaticIndexRange.hh>

Inheritance diagram for ObjexxFCL::StaticIndexRange:
Inheritance graph
[legend]
Collaboration diagram for ObjexxFCL::StaticIndexRange:
Collaboration graph
[legend]

List of all members.

Public Types

typedef DimensionExpression Expression

Public Member Functions

 StaticIndexRange ()
 Default Constructor.
 StaticIndexRange (StaticIndexRange const &I)
 Copy Constructor.
 StaticIndexRange (IndexRange const &I)
 IndexRange Constructor.
 StaticIndexRange (int const u_a)
 Upper Index Constructor.
 StaticIndexRange (Star const &star)
 Unbounded Upper Index Constructor.
 StaticIndexRange (Dimension const &u_dim_a)
 Upper Dimension Constructor.
 StaticIndexRange (Expression const &u_exp_a)
 Upper Expression Constructor.
 StaticIndexRange (int const l_a, int const u_a)
 Index Range Constructor.
 StaticIndexRange (Dimension const &l_dim_a, Dimension const &u_dim_a)
 Dimension Range Constructor.
 StaticIndexRange (Expression const &l_exp_a, Expression const &u_exp_a)
 Expression Range Constructor.
 StaticIndexRange (int const l_a, Dimension const &u_dim_a)
 Index and Dimension Constructor.
 StaticIndexRange (Dimension const &l_dim_a, int const u_a)
 Dimension and Index Constructor.
 StaticIndexRange (int const l_a, Expression const &u_exp_a)
 Index and Expression Constructor.
 StaticIndexRange (Expression const &l_exp_a, int const u_a)
 Expression and Index Constructor.
 StaticIndexRange (Dimension const &l_dim_a, Expression const &u_exp_a)
 Dimension and Expression Constructor.
 StaticIndexRange (Expression const &l_exp_a, Dimension const &u_dim_a)
 Expression and Dimension Constructor.
 StaticIndexRange (int const l_a, Star const &star)
 Index and Unbounded Upper Index Constructor.
 StaticIndexRange (Dimension const &l_dim_a, Star const &star)
 Dimension and Unbounded Upper Index Constructor.
 StaticIndexRange (Expression const &l_exp_a, Star const &star)
 Expression and Unbounded Upper Index Constructor.
virtual ~StaticIndexRange ()
 Destructor.
StaticIndexRangeoperator= (StaticIndexRange const &I)
 Copy Assignment.
StaticIndexRangeoperator= (IndexRange const &I)
 IndexRange Assignment.
StaticIndexRangeoperator= (int const u_a)
 Upper Index Assignment.
StaticIndexRangeoperator= (Star const &star)
 Unbounded Upper Index Assignment.
StaticIndexRangeoperator= (Dimension const &u_dim_a)
 Upper Dimension Assignment.
StaticIndexRangeoperator= (Expression const &u_exp_a)
 Upper Expression Assignment.
StaticIndexRangeassign (StaticIndexRange const &I)
 StaticIndexRange Assignment.
StaticIndexRangeassign (IndexRange const &I)
 IndexRange Assignment.
StaticIndexRangeassign (int const u_a)
 Upper Index Assignment.
StaticIndexRangeassign (Star const &star)
 Unbounded Upper Index Assignment.
StaticIndexRangeassign (Dimension const &u_dim_a)
 Upper Dimension Assignment.
StaticIndexRangeassign (Expression const &u_exp_a)
 Upper Expression Assignment.
StaticIndexRangeassign (int const l_a, int const u_a)
 Index Range Assignment.
StaticIndexRangeassign (Dimension const &l_dim_a, Dimension const &u_dim_a)
 Dimension Range Assignment.
StaticIndexRangeassign (Expression const &l_exp_a, Expression const &u_exp_a)
 Expression Range Assignment.
StaticIndexRangeassign (int const l_a, Dimension const &u_dim_a)
 Index and Dimension Assignment.
StaticIndexRangeassign (Dimension const &l_dim_a, int const u_a)
 Dimension and Index Assignment.
StaticIndexRangeassign (int const l_a, Expression const &u_exp_a)
 Index and Expression Assignment.
StaticIndexRangeassign (Expression const &l_exp_a, int const u_a)
 Expression and Index Assignment.
StaticIndexRangeassign (Dimension const &l_dim_a, Expression const &u_exp_a)
 Dimension and Expression Assignment.
StaticIndexRangeassign (Expression const &l_exp_a, Dimension const &u_dim_a)
 Expression and Dimension Assignment.
StaticIndexRangeassign (int const l_a, Star const &star)
 Index and Unbounded Upper Index Assignment.
StaticIndexRangeassign (Dimension const &l_dim_a, Star const &star)
 Dimension and Unbounded Upper Index Assignment.
StaticIndexRangeassign (Expression const &l_exp_a, Star const &star)
 Expression and Unbounded Upper Index Assignment.
void assign_value_of (IndexRange const &I)
 Assign Static Value of Another IndexRange: Faster Than operator =( I )
int l () const
 Lower Index.
int u () const
 Upper Index.
int offset (int const i) const
 Offset of an Index.
StaticIndexRangel (int const l_a)
 Lower Index Set.
StaticIndexRangeu (int const u_a)
 Upper Index Set.
StaticIndexRangeu (Star const &star)
 Unbounded Upper Index Set.
StaticIndexRangecontain (int const i)
 Expand to Contain an Index.
StaticIndexRangecontain (IndexRange const &I)
 Expand to Contain Another IndexRange.
StaticIndexRangeintersect (IndexRange const &I)
 Intersect With Another IndexRange.
StaticIndexRangeclear ()
 Clear.
StaticIndexRangeswap (StaticIndexRange &I)
 Swap.

Friends

void swap (StaticIndexRange &a, StaticIndexRange &b)
 Swap.

Detailed Description

StaticIndexRange: Static Index Range.

Remarks:
  • Zero-size range is indicated by ( l - 1 == u ) and ( size == 0 )
  • Upper-unbounded range is indicated by ( l - 2 == u ) and ( size == npos )
  • Legal ranges have ( l - 2 <= u ) with l and u in their allowed ranges

Member Typedef Documentation


Constructor & Destructor Documentation

ObjexxFCL::StaticIndexRange::StaticIndexRange ( ) [inline]

Default Constructor.

ObjexxFCL::StaticIndexRange::StaticIndexRange ( StaticIndexRange const &  I) [inline]

Copy Constructor.

ObjexxFCL::StaticIndexRange::StaticIndexRange ( IndexRange const &  I) [inline]
ObjexxFCL::StaticIndexRange::StaticIndexRange ( int const  u_a) [inline]

Upper Index Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Star const &  star) [inline]

Unbounded Upper Index Constructor.

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Dimension const &  u_dim_a) [inline]

Upper Dimension Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Expression const &  u_exp_a) [inline]

Upper Expression Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( int const  l_a,
int const  u_a 
) [inline]

Index Range Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Dimension const &  l_dim_a,
Dimension const &  u_dim_a 
) [inline]

Dimension Range Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Expression const &  l_exp_a,
Expression const &  u_exp_a 
) [inline]

Expression Range Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( int const  l_a,
Dimension const &  u_dim_a 
) [inline]

Index and Dimension Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Dimension const &  l_dim_a,
int const  u_a 
) [inline]

Dimension and Index Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( int const  l_a,
Expression const &  u_exp_a 
) [inline]

Index and Expression Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Expression const &  l_exp_a,
int const  u_a 
) [inline]

Expression and Index Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Dimension const &  l_dim_a,
Expression const &  u_exp_a 
) [inline]

Dimension and Expression Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Expression const &  l_exp_a,
Dimension const &  u_dim_a 
) [inline]

Expression and Dimension Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( int const  l_a,
Star const &  star 
) [inline]

Index and Unbounded Upper Index Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Dimension const &  l_dim_a,
Star const &  star 
) [inline]

Dimension and Unbounded Upper Index Constructor.

References ObjexxFCL::IndexRange::legal_static().

ObjexxFCL::StaticIndexRange::StaticIndexRange ( Expression const &  l_exp_a,
Star const &  star 
) [inline]

Expression and Unbounded Upper Index Constructor.

References ObjexxFCL::IndexRange::legal_static().

virtual ObjexxFCL::StaticIndexRange::~StaticIndexRange ( ) [inline, virtual]

Destructor.


Member Function Documentation

StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( StaticIndexRange const &  I) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( IndexRange const &  I) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( int const  u_a) [inline, virtual]

Upper Index Assignment.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::legal_static(), and ObjexxFCL::IndexRange::operator=().

StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( int const  l_a,
Dimension const &  u_dim_a 
) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Dimension const &  l_dim_a,
int const  u_a 
) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( int const  l_a,
Expression const &  u_exp_a 
) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Expression const &  l_exp_a,
int const  u_a 
) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Star const &  star) [inline, virtual]

Unbounded Upper Index Assignment.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::operator=().

StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Dimension const &  l_dim_a,
Expression const &  u_exp_a 
) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Expression const &  l_exp_a,
Dimension const &  u_dim_a 
) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Dimension const &  u_dim_a) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( int const  l_a,
Star const &  star 
) [inline, virtual]

Index and Unbounded Upper Index Assignment.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::assign(), and ObjexxFCL::IndexRange::legal_static().

StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Dimension const &  l_dim_a,
Star const &  star 
) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Expression const &  u_exp_a) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( int const  l_a,
int const  u_a 
) [inline, virtual]

Index Range Assignment.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::assign(), and ObjexxFCL::IndexRange::legal_static().

StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Expression const &  l_exp_a,
Star const &  star 
) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Dimension const &  l_dim_a,
Dimension const &  u_dim_a 
) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::assign ( Expression const &  l_exp_a,
Expression const &  u_exp_a 
) [inline]
void ObjexxFCL::StaticIndexRange::assign_value_of ( IndexRange const &  I) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::clear ( ) [inline, virtual]
StaticIndexRange& ObjexxFCL::StaticIndexRange::contain ( int const  i) [inline, virtual]

Expand to Contain an Index.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::contain(), and ObjexxFCL::IndexRange::legal_static().

StaticIndexRange& ObjexxFCL::StaticIndexRange::contain ( IndexRange const &  I) [inline, virtual]

Expand to Contain Another IndexRange.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::contain(), and ObjexxFCL::IndexRange::legal_static().

StaticIndexRange& ObjexxFCL::StaticIndexRange::intersect ( IndexRange const &  I) [inline, virtual]
int ObjexxFCL::StaticIndexRange::l ( ) const [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::l ( int const  l_a) [inline, virtual]

Lower Index Set.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::l(), and ObjexxFCL::IndexRange::legal_static().

int ObjexxFCL::StaticIndexRange::offset ( int const  i) const [inline]

Offset of an Index.

Reimplemented from ObjexxFCL::IndexRange.

StaticIndexRange& ObjexxFCL::StaticIndexRange::operator= ( StaticIndexRange const &  I) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::operator= ( Star const &  star) [inline, virtual]

Unbounded Upper Index Assignment.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::operator=().

StaticIndexRange& ObjexxFCL::StaticIndexRange::operator= ( IndexRange const &  I) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::operator= ( Dimension const &  u_dim_a) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::operator= ( int const  u_a) [inline, virtual]

Upper Index Assignment.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::legal_static(), and ObjexxFCL::IndexRange::operator=().

StaticIndexRange& ObjexxFCL::StaticIndexRange::operator= ( Expression const &  u_exp_a) [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::swap ( StaticIndexRange I) [inline]
int ObjexxFCL::StaticIndexRange::u ( ) const [inline]
StaticIndexRange& ObjexxFCL::StaticIndexRange::u ( Star const &  star) [inline, virtual]

Unbounded Upper Index Set.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::legal_static(), and ObjexxFCL::IndexRange::u().

StaticIndexRange& ObjexxFCL::StaticIndexRange::u ( int const  u_a) [inline, virtual]

Upper Index Set.

Reimplemented from ObjexxFCL::IndexRange.

References ObjexxFCL::IndexRange::legal_static(), and ObjexxFCL::IndexRange::u().


Friends And Related Function Documentation

void swap ( ObjexxFCL::StaticIndexRange a,
ObjexxFCL::StaticIndexRange 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