AllVariables Class Reference

the all data view. More...

Inheritance diagram for AllVariables:

Variables List of all members.

Public Member Functions

 AllVariables ()
 default constructor
 AllVariables (const ProblemDescDB &problem_db, const pair< short, short > &view)
 standard constructor
 ~AllVariables ()
 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 &cv_labels)
 set the active continuous variable labels
const StringArraydiscrete_variable_labels () const
 return the active discrete variable labels
void discrete_variable_labels (const StringArray &dv_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
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 allContinuousVars
 (design, uncertain, and state).
IntVector allDiscreteVars
 (design and state).
StringArray allContinuousLabels
 (design, uncertain, and state).
StringArray allDiscreteLabels
 (design and state).
StringArray allDiscreteVarTypes
 array of variable types for all of the discrete variables

Friends

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

Detailed Description

the all data view.

Derived variables classes take different views of the design, uncertain, and state variable types and the continuous and discrete domain types. The AllVariables derived class combines design, uncertain, and state variable types but separates continuous and discrete domain types. The result is a single array of continuous variables (allContinuousVars) and a single array of discrete variables (allDiscreteVars). Parameter and DACE studies currently use this approach (see Variables::get_variables(problem_db)).


Constructor & Destructor Documentation

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

standard constructor

In this class, the all data approach (design, uncertain, and state types are combined) is used. Iterators/strategies which use this class include: parameter studies, DACE, and the all_variables mode of nond_sampling. Extract fundamental variable types and labels and combine them into allContinuousVars, allDiscreteVars, allContinuousLabels, and allDiscreteLabels.


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