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

Dimension: Dynamic Dimension. More...

#include <Dimension.hh>

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

List of all members.

Public Types

typedef DimensionExpression Expression

Public Member Functions

 Dimension ()
 Default Constructor.
 Dimension (Dimension const &dim)
 Copy Constructor.
 Dimension (int const i)
 int Constructor
 Dimension (double const d)
 double Constructor
 Dimension (Expression const &exp)
 Expression Constructor.
 Dimension (Expression *exp_p_a)
 Expression Pointer Constructor (Ownership Transfer)
Dimensionclone () const
 Clone.
Dimensionreference_copy () const
 Reference Copy.
virtual ~Dimension ()
 Destructor.
 operator int () const
 int Conversion
 operator double () const
 double Conversion
Dimensionoperator= (Dimension const &dim)
 Copy Assignment: Creates a reference to the passed Dimension.
Dimensionoperator= (Expression const &exp)
 Expression Assignment.
Dimensionoperator= (int const i)
 int Assignment
Dimensionoperator= (double const d)
 double Assignment
Dimensionoperator+= (Dimension const &dim)
 += Dimension
Dimensionoperator+= (Expression const &exp)
 += Expression
Dimensionoperator+= (int const i)
 += int
Dimensionoperator+= (double const d)
 += double
Dimensionoperator-= (Dimension const &dim)
 -= Dimension
Dimensionoperator-= (Expression const &exp)
 -= Expression
Dimensionoperator-= (int const i)
 -= int
Dimensionoperator-= (double const d)
 -= double
Dimensionoperator*= (Dimension const &dim)
 *= Dimension
Dimensionoperator*= (Expression const &exp)
 *= Expression
Dimensionoperator*= (int const i)
 *= int
Dimensionoperator*= (double const d)
 *= double
Dimensionoperator/= (Dimension const &dim)
 /= Dimension
Dimensionoperator/= (Expression const &exp)
 /= Expression
Dimensionoperator/= (int const i)
 /= int
Dimensionoperator/= (double const d)
 /= double
Dimensionassign_value_of (Dimension const &dim)
 Dimension Value-Semantics Assignment.
Dimensionassign_if (int const i, double const m=1.0)
 int Assignment if Bigger than Value or Smaller than Multiplier * Value
Dimensionassign_if (double const d, double const m=1.0)
 double Assignment if Bigger than Value or Smaller than Multiplier * Value
Dimensionassign_if_half (int const i)
 int Assignment if Bigger than Value or Smaller than Half Value
Dimensionassign_if_half (double const d)
 double Assignment if Bigger than Value or Smaller than Half Value
Dimensionassign_if_bigger (int const i)
 int Assignment if Bigger than Value
Dimensionassign_if_bigger (double const d)
 double Assignment if Bigger than Value
Dimensionassign_if_nic (int const i, double const m=1.0)
 int Assignment if Bigger than Value or Smaller than Multiplier * Value: Notify if Changed
Dimensionassign_if_nic (double const d, double const m=1.0)
 double Assignment if Bigger than Value or Smaller than Multiplier * Value: Notify if Changed
Dimensionassign_if_half_nic (int const i)
 int Assignment if Bigger than Value or Smaller than Half Value: Notify if Changed
Dimensionassign_if_half_nic (double const d)
 double Assignment if Bigger than Value or Smaller than Half Value: Notify if Changed
Dimensionassign_if_bigger_nic (int const i)
 int Assignment if Bigger than Value: Notify if Changed
Dimensionassign_if_bigger_nic (double const d)
 double Assignment if Bigger than Value: Notify if Changed
Dimensionoperator++ ()
 ++Dimension
Dimension const operator++ (int)
 Dimension++.
Dimensionoperator-- ()
 --Dimension
Dimension const operator-- (int)
 Dimension--.
bool initialized () const
 Initialized?
bool constant () const
 Constant?
bool reference () const
 Reference?
bool reducible () const
 Reducible?
int operator() () const
 Value.
int value () const
 Value.
int zvalue () const
 Value: Zero if Uninitialized.
Expression const * exp_p () const
 Expression Pointer.
Expression const & exp () const
 Expression.
Expressionexp_clone () const
 Expression Clone.
Dimensionclear ()
 Clear the Dimension.
Dimensionclear_no_notify ()
 Clear the Dimension Without Notification.
Dimensionswap (Dimension &dim)
 Swap.
Dimensionswap_no_notify (Dimension &dim)
 Swap Without Notification.
void update ()
 Update.
void destructed (Subject const &subject)
 Update for Destruction of a Subject.

Friends

class DynamicIndexRange
void swap (Dimension &a, Dimension &b)
 Swap.
void swap_no_notify (Dimension &a, Dimension &b)
 Swap.

Detailed Description

Dimension: Dynamic Dimension.


Member Typedef Documentation


Constructor & Destructor Documentation

ObjexxFCL::Dimension::Dimension ( ) [inline]

Default Constructor.

Referenced by clone(), and reference_copy().

ObjexxFCL::Dimension::Dimension ( Dimension const &  dim) [explicit]

Copy Constructor.

Note:
Copy creates a reference to the passed Dimension: Not intended for pass-by-value
ObjexxFCL::Dimension::Dimension ( int const  i) [explicit]

int Constructor

ObjexxFCL::Dimension::Dimension ( double const  d) [explicit]

double Constructor

ObjexxFCL::Dimension::Dimension ( Expression const &  exp) [inline, explicit]

Expression Constructor.

ObjexxFCL::Dimension::Dimension ( Expression exp_p_a) [inline, explicit]

Expression Pointer Constructor (Ownership Transfer)

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

Destructor.


Member Function Documentation

Dimension & ObjexxFCL::Dimension::assign_if ( int const  i,
double const  m = 1.0 
)

int Assignment if Bigger than Value or Smaller than Multiplier * Value

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::assign_if ( double const  d,
double const  m = 1.0 
)

double Assignment if Bigger than Value or Smaller than Multiplier * Value

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::assign_if_bigger ( int const  i)

int Assignment if Bigger than Value

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::assign_if_bigger ( double const  d)

double Assignment if Bigger than Value

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::assign_if_bigger_nic ( int const  i)

int Assignment if Bigger than Value: Notify if Changed

Dimension & ObjexxFCL::Dimension::assign_if_bigger_nic ( double const  d)

double Assignment if Bigger than Value: Notify if Changed

Dimension & ObjexxFCL::Dimension::assign_if_half ( double const  d)

double Assignment if Bigger than Value or Smaller than Half Value

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::assign_if_half ( int const  i)

int Assignment if Bigger than Value or Smaller than Half Value

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::assign_if_half_nic ( int const  i)

int Assignment if Bigger than Value or Smaller than Half Value: Notify if Changed

Dimension & ObjexxFCL::Dimension::assign_if_half_nic ( double const  d)

double Assignment if Bigger than Value or Smaller than Half Value: Notify if Changed

Dimension & ObjexxFCL::Dimension::assign_if_nic ( int const  i,
double const  m = 1.0 
)

int Assignment if Bigger than Value or Smaller than Multiplier * Value: Notify if Changed

Dimension & ObjexxFCL::Dimension::assign_if_nic ( double const  d,
double const  m = 1.0 
)

double Assignment if Bigger than Value or Smaller than Multiplier * Value: Notify if Changed

Dimension& ObjexxFCL::Dimension::assign_value_of ( Dimension const &  dim) [inline]

Dimension Value-Semantics Assignment.

References exp_clone(), ObjexxFCL::Observer::notify(), and update().

Dimension& ObjexxFCL::Dimension::clear ( ) [inline]

Clear the Dimension.

References ObjexxFCL::Observer::notify().

Referenced by ObjexxFCL::operator>>().

Dimension& ObjexxFCL::Dimension::clear_no_notify ( ) [inline]

Clear the Dimension Without Notification.

Dimension* ObjexxFCL::Dimension::clone ( ) const [inline]

Clone.

References Dimension(), and exp_clone().

bool ObjexxFCL::Dimension::constant ( ) const [inline]
void ObjexxFCL::Dimension::destructed ( Subject const &  subject) [inline, virtual]

Update for Destruction of a Subject.

Implements ObjexxFCL::Observer.

References ObjexxFCL::DimensionExpression::destructed().

Expression const& ObjexxFCL::Dimension::exp ( ) const [inline]

Expression.

Referenced by ObjexxFCL::DimensionExpressionRef::clone().

Expression* ObjexxFCL::Dimension::exp_clone ( ) const [inline]

Expression Clone.

References ObjexxFCL::DimensionExpression::clone().

Referenced by assign_value_of(), and clone().

Expression const* ObjexxFCL::Dimension::exp_p ( ) const [inline]

Expression Pointer.

Referenced by ObjexxFCL::DimensionExpressionRef::clone().

bool ObjexxFCL::Dimension::initialized ( ) const [inline]
ObjexxFCL::Dimension::operator double ( ) const [inline]

double Conversion

ObjexxFCL::Dimension::operator int ( ) const [inline]

int Conversion

int ObjexxFCL::Dimension::operator() ( ) const [inline]

Value.

Dimension & ObjexxFCL::Dimension::operator*= ( Dimension const &  dim)
Dimension & ObjexxFCL::Dimension::operator*= ( Expression const &  exp)

*= Expression

References ObjexxFCL::DimensionExpression::clone().

Dimension & ObjexxFCL::Dimension::operator*= ( int const  i)

*= int

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::operator*= ( double const  d)

*= double

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::operator++ ( )

++Dimension

References ObjexxFCL::Observer::notify(), and update().

Dimension const ObjexxFCL::Dimension::operator++ ( int  )

Dimension++.

Dimension & ObjexxFCL::Dimension::operator+= ( Dimension const &  dim)
Dimension & ObjexxFCL::Dimension::operator+= ( Expression const &  exp)

+= Expression

References ObjexxFCL::DimensionExpression::clone().

Dimension & ObjexxFCL::Dimension::operator+= ( int const  i)

+= int

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::operator+= ( double const  d)

+= double

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::operator-- ( )

--Dimension

References ObjexxFCL::Observer::notify(), and update().

Dimension const ObjexxFCL::Dimension::operator-- ( int  )

Dimension--.

Dimension & ObjexxFCL::Dimension::operator-= ( double const  d)

-= double

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::operator-= ( Dimension const &  dim)
Dimension & ObjexxFCL::Dimension::operator-= ( Expression const &  exp)

-= Expression

References ObjexxFCL::DimensionExpression::clone().

Dimension & ObjexxFCL::Dimension::operator-= ( int const  i)

-= int

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::operator/= ( Dimension const &  dim)
Dimension & ObjexxFCL::Dimension::operator/= ( int const  i)

/= int

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::operator/= ( Expression const &  exp)

/= Expression

References ObjexxFCL::DimensionExpression::clone().

Dimension & ObjexxFCL::Dimension::operator/= ( double const  d)

/= double

References ObjexxFCL::Observer::notify(), and update().

Dimension & ObjexxFCL::Dimension::operator= ( double const  d)

double Assignment

Dimension& ObjexxFCL::Dimension::operator= ( Expression const &  exp) [inline]

Expression Assignment.

References ObjexxFCL::DimensionExpression::clone().

Dimension & ObjexxFCL::Dimension::operator= ( int const  i)

int Assignment

Dimension & ObjexxFCL::Dimension::operator= ( Dimension const &  dim)

Copy Assignment: Creates a reference to the passed Dimension.

Copy Assignment.

References ObjexxFCL::Observer::notify(), and update().

bool ObjexxFCL::Dimension::reducible ( ) const [inline]
bool ObjexxFCL::Dimension::reference ( ) const [inline]
Dimension* ObjexxFCL::Dimension::reference_copy ( ) const [inline]
Dimension& ObjexxFCL::Dimension::swap ( Dimension dim) [inline]
Dimension& ObjexxFCL::Dimension::swap_no_notify ( Dimension dim) [inline]

Swap Without Notification.

References swap().

Referenced by ObjexxFCL::swap_no_notify().

void ObjexxFCL::Dimension::update ( ) [inline, virtual]
int ObjexxFCL::Dimension::value ( ) const [inline]
int ObjexxFCL::Dimension::zvalue ( ) const [inline]

Friends And Related Function Documentation

friend class DynamicIndexRange [friend]
void swap ( ObjexxFCL::Dimension a,
ObjexxFCL::Dimension b 
) [friend]

Swap.

void swap_no_notify ( Dimension a,
Dimension b 
) [friend]

Swap.


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