DistinctVariables Class Reference

the default data view (no variable or domain type array merging). More...

Inheritance diagram for DistinctVariables:

Variables List of all members.

Public Member Functions

 DistinctVariables ()
 default constructor
 DistinctVariables (const ProblemDescDB &problem_db, const pair< short, short > &view)
 standard constructor
 ~DistinctVariables ()
 destructor
size_t tv () const
 Returns total number of vars.
const RealVectorcontinuous_variables () const
 return the active continuous variables
void continuous_variable (const Real &c_var, const size_t &i)
 set an active continuous variable
void continuous_variables (const RealVector &c_vars)
 set the active continuous variables
const IntVectordiscrete_variables () const
 return the active discrete variables
void discrete_variable (const int &d_var, const size_t &i)
 set an active discrete variable
void discrete_variables (const IntVector &d_vars)
 set the active discrete variables
const StringArraycontinuous_variable_labels () const
 return the active continuous variable labels
void continuous_variable_labels (const StringArray &c_v_labels)
 set the active continuous variable labels
const StringArraydiscrete_variable_labels () const
 return the active discrete variable labels
void discrete_variable_labels (const StringArray &d_v_labels)
 set the active discrete variable labels
const StringArraycontinuous_variable_types () const
 return the active continuous variable types
const StringArraydiscrete_variable_types () const
 return the active discrete variable types
const UIntArraycontinuous_variable_ids () const
 return the active continuous variable position identifiers
const RealVectorinactive_continuous_variables () const
 return the inactive continuous variables
void inactive_continuous_variables (const RealVector &i_c_vars)
 set the inactive continuous variables
const IntVectorinactive_discrete_variables () const
 return the inactive discrete variables
void inactive_discrete_variables (const IntVector &i_d_vars)
 set the inactive discrete variables
const StringArrayinactive_continuous_variable_labels () const
 return the inactive continuous variable labels
void inactive_continuous_variable_labels (const StringArray &i_c_v_labels)
 set the inactive continuous variable labels
const StringArrayinactive_discrete_variable_labels () const
 return the inactive discrete variable labels
void inactive_discrete_variable_labels (const StringArray &i_d_v_labels)
 set the inactive discrete variable labels
const UIntArrayinactive_continuous_variable_ids () const
 return the inactive continuous variable position identifiers
size_t acv () const
 returns total number of continuous vars
size_t adv () const
 returns total number of discrete vars
RealVector all_continuous_variables () const
 returns a single array with all continuous variables
void all_continuous_variables (const RealVector &a_c_vars)
 sets all continuous variables using a single array
IntVector all_discrete_variables () const
 returns a single array with all discrete variables
void all_discrete_variables (const IntVector &a_d_vars)
 sets all discrete variables using a single array
StringArray all_continuous_variable_labels () const
 returns a single array with all continuous variable labels
void all_continuous_variable_labels (const StringArray &a_c_v_labels)
 sets all continuous variable labels using a single array
StringArray all_discrete_variable_labels () const
 returns a single array with all discrete variable labels
void all_discrete_variable_labels (const StringArray &a_d_v_labels)
 sets all discrete variable labels using a single array
StringArray all_variable_labels () const
 returns a single array with all variable labels
const StringArrayall_discrete_variable_types () const
 return the all discrete variable types
void read (istream &s)
 read a variables object from an istream
void write (ostream &s) const
 write a variables object to an ostream
void write_aprepro (ostream &s) const
 write a variables object to an ostream in aprepro format
void read_annotated (istream &s)
 read a variables object in annotated format from an istream
void write_annotated (ostream &s) const
 write a variables object in annotated format to an ostream
void write_tabular (ostream &s) const
 write a variables object in tabular format to an ostream
void read (BiStream &s)
 read a variables object from the binary restart stream
void write (BoStream &s) const
 write a variables object to the binary restart stream
void read (MPIUnpackBuffer &s)
 read a variables object from a packed MPI buffer
void write (MPIPackBuffer &s) const
 write a variables object to a packed MPI buffer

Protected Member Functions

void copy_rep (const Variables *vars_rep)
 Used by copy() to copy the contents of a letter class.
void reshape_rep (const Sizet2DArray &vars_comps)
 Used by reshape() to reshape the contents of a letter class.

Private Member Functions

void build_types_ids ()
 construct VarTypes and VarIds arrays using variablesComponents

Private Attributes

RealVector continuousDesignVars
 the continuous design variables array
IntVector discreteDesignVars
 the discrete design variables array
RealVector uncertainVars
 the uncertain variables array
RealVector continuousStateVars
 the continuous state variables array
IntVector discreteStateVars
 the discrete state variables array
StringArray continuousDesignLabels
 the continuous design variables label array
StringArray discreteDesignLabels
 the discrete design variables label array
StringArray uncertainLabels
 the uncertain variables label array
StringArray continuousStateLabels
 the continuous state variables label array
StringArray discreteStateLabels
 the discrete state variables label array
StringArray continuousVarTypes
 array of variable types for the active continuous variables
StringArray discreteVarTypes
 array of variable types for the active discrete variables
StringArray allDiscreteVarTypes
 array of variable types for all of the discrete variables
UIntArray continuousVarIds
 array of position identifiers for the active continuous variables
UIntArray inactiveContinuousVarIds
 array of position identifiers for the inactive continuous variables

Friends

bool operator== (const DistinctVariables &vars1, const DistinctVariables &vars2)
 equality operator
std::size_t hash_value (const DistinctVariables &vars)
 hash_value
bool binary_equal_to (const DistinctVariables &vars1, const DistinctVariables &vars2)
 binary_equal_to (since 'operator==' is not suitable for boost/hash_set)

Detailed Description

the default data view (no variable or domain type array merging).

Derived variables classes take different views of the design, uncertain, and state variable types and the continuous and discrete domain types. The DistinctVariables derived class separates the design, uncertain, and state variable types as well as the continuous and discrete domain types. The result is separate arrays for continuous design, discrete design, uncertain, continuous state, and discrete state variables. This is the default approach, so all iterators and strategies not specifically utilizing the All or Merged views use this approach (see Variables::get_variables(problem_db)).


Constructor & Destructor Documentation

DistinctVariables ( const ProblemDescDB problem_db,
const pair< short, short > &  view 
)

standard constructor

In this class, the distinct approach is used (design, uncertain, and state variable types and continuous and discrete domain types are distinct). Most iterators/strategies use this approach.


Friends And Related Function Documentation

bool operator== ( const DistinctVariables vars1,
const DistinctVariables vars2 
) [friend]

equality operator

Checks each array using operator== from data_types.C. Labels are ignored.


Member Data Documentation

UIntArray continuousVarIds [private]

array of position identifiers for the active continuous variables

These identifiers define positions of the active continuous variables within the total variable sequence.

UIntArray inactiveContinuousVarIds [private]

array of position identifiers for the inactive continuous variables

These identifiers define positions of the inactive continuous variables within the total variable sequence.


The documentation for this class was generated from the following files:
Generated on Wed Nov 5 19:54:06 2008 for DAKOTA by  doxygen 1.5.1