Dakota  Version 6.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
Analyzer Class Reference

Base class for NonD, DACE, and ParamStudy branches of the iterator hierarchy. More...

Inheritance diagram for Analyzer:
Iterator NonD PStudyDACE Verification NonDCalibration NonDExpansion NonDIntegration NonDInterval NonDPOFDarts NonDReliability NonDRKDDarts NonDSampling DDACEDesignCompExp FSUDesignCompExp ParamStudy PSUADEDesignCompExp RichExtrapVerification

Public Member Functions

const VariablesArray & all_variables ()
 return the complete set of evaluated variables
 
const RealMatrix & all_samples ()
 return the complete set of evaluated samples
 
const IntResponseMap & all_responses () const
 return the complete set of computed responses
 
bool resize ()
 reinitializes iterator based on new variable size
 
int num_samples () const
 
virtual void vary_pattern (bool pattern_flag)
 sets varyPattern in derived classes that support it
 
- Public Member Functions inherited from Iterator
 Iterator ()
 default constructor More...
 
 Iterator (ProblemDescDB &problem_db)
 standard envelope constructor, which constructs its own model(s) More...
 
 Iterator (ProblemDescDB &problem_db, Model &model)
 alternate envelope constructor which uses the ProblemDescDB but accepts a model from a higher level (meta-iterator) context, instead of constructing its own More...
 
 Iterator (const String &method_string, Model &model)
 alternate envelope constructor for instantiations by name without the ProblemDescDB More...
 
 Iterator (const Iterator &iterator)
 copy constructor More...
 
virtual ~Iterator ()
 destructor More...
 
Iterator operator= (const Iterator &iterator)
 assignment operator More...
 
virtual void derived_set_communicators (ParLevLIter pl_iter)
 derived class contributions to setting the communicators associated with this Iterator instance
 
virtual void derived_free_communicators (ParLevLIter pl_iter)
 derived class contributions to freeing the communicators associated with this Iterator instance
 
virtual void core_run ()
 core portion of run; implemented by all derived classes and may include pre/post steps in lieu of separate pre/post More...
 
virtual void post_input ()
 read tabular data for post-run mode
 
virtual void reset ()
 restore initial state for repeated sub-iterator executions
 
virtual void initialize_iterator (int job_index)
 used by IteratorScheduler to set the starting data for a run
 
virtual void pack_parameters_buffer (MPIPackBuffer &send_buffer, int job_index)
 used by IteratorScheduler to pack starting data for an iterator run
 
virtual void unpack_parameters_buffer (MPIUnpackBuffer &recv_buffer)
 used by IteratorScheduler to unpack starting data for an iterator run
 
virtual void unpack_parameters_initialize (MPIUnpackBuffer &recv_buffer)
 used by IteratorScheduler to unpack starting data and initialize an iterator run
 
virtual void pack_results_buffer (MPIPackBuffer &send_buffer, int job_index)
 used by IteratorScheduler to pack results data from an iterator run
 
virtual void unpack_results_buffer (MPIUnpackBuffer &recv_buffer, int job_index)
 used by IteratorScheduler to unpack results data from an iterator run
 
virtual void update_local_results (int job_index)
 used by IteratorScheduler to update local results arrays
 
virtual bool accepts_multiple_points () const
 indicates if this iterator accepts multiple initial points. Default return is false. Override to return true if appropriate.
 
virtual void initial_points (const VariablesArray &pts)
 sets the multiple initial points for this iterator. This should only be used if accepts_multiple_points() returns true.
 
virtual void initialize_graphics (int iterator_server_id=1)
 initialize the 2D graphics window and the tabular graphics data More...
 
virtual unsigned short uses_method () const
 return name of any enabling iterator used by this iterator More...
 
virtual void method_recourse ()
 perform a method switch, if possible, due to a detected conflict
 
virtual void sampling_reset (int min_samples, bool all_data_flag, bool stats_flag)
 reset sampling iterator to use at least min_samples
 
virtual void sampling_reference (int samples_ref)
 set reference number of samples, which is a lower bound during reset
 
virtual void sampling_increment ()
 increment to next in sequence of refinement samples
 
virtual unsigned short sampling_scheme () const
 return sampling name
 
virtual IntIntPair estimate_partition_bounds ()
 estimate the minimum and maximum partition sizes that can be utilized by this Iterator
 
void init_communicators (ParLevLIter pl_iter)
 initialize the communicators associated with this Iterator instance
 
void set_communicators (ParLevLIter pl_iter)
 set the communicators associated with this Iterator instance
 
void free_communicators (ParLevLIter pl_iter)
 free the communicators associated with this Iterator instance
 
void resize_communicators (ParLevLIter pl_iter, bool reinit_comms)
 Resize the communicators. This is called from the letter's resize()
 
void parallel_configuration_iterator (ParConfigLIter pc_iter)
 set methodPCIter
 
ParConfigLIter parallel_configuration_iterator () const
 return methodPCIter
 
void run (ParLevLIter pl_iter)
 invoke set_communicators(pl_iter) prior to run()
 
void run ()
 orchestrate initialize/pre/core/post/finalize phases More...
 
void assign_rep (Iterator *iterator_rep, bool ref_count_incr=true)
 replaces existing letter with a new one More...
 
void iterated_model (const Model &model)
 set the iteratedModel (iterators and meta-iterators using a single model instance)
 
Modeliterated_model ()
 return the iteratedModel (iterators & meta-iterators using a single model instance)
 
ProblemDescDBproblem_description_db () const
 return the problem description database (probDescDB)
 
ParallelLibraryparallel_library () const
 return the parallel library (parallelLib)
 
void method_name (unsigned short m_name)
 set the method name to an enumeration value
 
unsigned short method_name () const
 return the method name via its native enumeration value
 
void method_string (const String &m_str)
 set the method name by string
 
String method_string () const
 return the method name by string
 
String method_enum_to_string (unsigned short method_name) const
 convert a method name enumeration value to a string
 
unsigned short method_string_to_enum (const String &method_name) const
 convert a method name string to an enumeration value
 
String submethod_enum_to_string (unsigned short submethod_name) const
 convert a method name enumeration value to a string
 
const String & method_id () const
 return the method identifier (methodId)
 
int maximum_evaluation_concurrency () const
 return the maximum evaluation concurrency supported by the iterator
 
void maximum_evaluation_concurrency (int max_conc)
 set the maximum evaluation concurrency supported by the iterator
 
void convergence_tolerance (Real conv_tol)
 set the method convergence tolerance (convergenceTol)
 
Real convergence_tolerance () const
 return the method convergence tolerance (convergenceTol)
 
void output_level (short out_lev)
 set the method output level (outputLevel)
 
short output_level () const
 return the method output level (outputLevel)
 
void summary_output (bool summary_output_flag)
 Set summary output control; true enables evaluation/results summary.
 
size_t num_final_solutions () const
 return the number of solutions to retain in best variables/response arrays
 
void num_final_solutions (size_t num_final)
 set the number of solutions to retain in best variables/response arrays
 
void active_set (const ActiveSet &set)
 set the default active set vector (for use with iterators that employ evaluate_parameter_sets())
 
const ActiveSetactive_set () const
 return the default active set vector (used by iterators that employ evaluate_parameter_sets())
 
void sub_iterator_flag (bool si_flag)
 set subIteratorFlag (and update summaryOutputFlag if needed)
 
void active_variable_mappings (const SizetArray &c_index1, const SizetArray &di_index1, const SizetArray &ds_index1, const SizetArray &dr_index1, const ShortArray &c_target2, const ShortArray &di_target2, const ShortArray &ds_target2, const ShortArray &dr_target2)
 set primaryA{CV,DIV,DRV}MapIndices, secondaryA{CV,DIV,DRV}MapTargets
 
bool is_null () const
 function to check iteratorRep (does this envelope contain a letter?)
 
Iteratoriterator_rep () const
 returns iteratorRep for access to derived class member functions that are not mapped to the top Iterator level
 
virtual void eval_tag_prefix (const String &eval_id_str)
 set the hierarchical eval ID tag prefix More...
 

Protected Member Functions

 Analyzer ()
 default constructor
 
 Analyzer (ProblemDescDB &problem_db, Model &model)
 standard constructor
 
 Analyzer (unsigned short method_name, Model &model)
 alternate constructor for instantiations "on the fly" with a Model
 
 Analyzer (unsigned short method_name)
 alternate constructor for instantiations "on the fly" without a Model
 
 ~Analyzer ()
 destructor
 
virtual void get_parameter_sets (Model &model)
 Returns one block of samples (ndim * num_samples)
 
virtual void update_model_from_sample (Model &model, const Real *sample_vars)
 update model's current variables with data from sample
 
virtual void update_model_from_variables (Model &model, const Variables &vars)
 update model's current variables with data from vars
 
virtual void sample_to_variables (const Real *sample_vars, Variables &vars)
 convert column of samples array to variables; derived classes may reimplement for more than active continuous variables More...
 
void update_from_model (const Model &model)
 set inherited data attributes based on extractions from incoming model
 
void initialize_run ()
 utility function to perform common operations prior to pre_run(); typically memory initialization; setting of instance pointers More...
 
void pre_run ()
 pre-run portion of run (optional); re-implemented by Iterators which can generate all Variables (parameter sets) a priori More...
 
void post_run (std::ostream &s)
 post-run portion of run (optional); verbose to print results; re-implemented by Iterators that can read all Variables/Responses and perform final analysis phase in a standalone way More...
 
void finalize_run ()
 utility function to perform common operations following post_run(); deallocation and resetting of instance pointers More...
 
void pre_output ()
 
void print_results (std::ostream &s)
 print the final iterator results More...
 
const Modelalgorithm_space_model () const
 
const Variablesvariables_results () const
 return a single final iterator solution (variables)
 
const Responseresponse_results () const
 return a single final iterator solution (response)
 
const VariablesArray & variables_array_results ()
 return multiple final iterator solutions (variables). This should only be used if returns_multiple_points() returns true.
 
const ResponseArray & response_array_results ()
 return multiple final iterator solutions (response). This should only be used if returns_multiple_points() returns true.
 
void response_results_active_set (const ActiveSet &set)
 set the requested data for the final iterator response results
 
bool compact_mode () const
 returns Analyzer::compactMode
 
bool returns_multiple_points () const
 indicates if this iterator returns multiple final points. Default return is false. Override to return true if appropriate.
 
void evaluate_parameter_sets (Model &model, bool log_resp_flag, bool log_best_flag)
 perform function evaluations to map parameter sets (allVariables) into response sets (allResponses) More...
 
void variance_based_decomp (int ncont, int ndiscint, int ndiscreal, int num_samples)
 
void read_variables_responses (int num_evals, size_t num_vars)
 convenience function for reading variables/responses (used in derived classes post_input) More...
 
void print_sobol_indices (std::ostream &s) const
 Printing of VBD results. More...
 
void samples_to_variables_array (const RealMatrix &sample_matrix, VariablesArray &vars_array)
 convert samples array to variables array; e.g., allSamples to allVariables
 
virtual void variables_to_sample (const Variables &vars, Real *sample_c_vars)
 convert the active continuous variables into a column of allSamples More...
 
void variables_array_to_samples (const VariablesArray &vars_array, RealMatrix &sample_matrix)
 convert variables array to samples array; e.g., allVariables to allSamples
 
- Protected Member Functions inherited from Iterator
 Iterator (BaseConstructor, ProblemDescDB &problem_db)
 constructor initializes the base class part of letter classes (BaseConstructor overloading avoids infinite recursion in the derived class constructors - Coplien, p. 139) More...
 
 Iterator (NoDBBaseConstructor, unsigned short method_name, Model &model)
 alternate constructor for base iterator classes constructed on the fly More...
 
 Iterator (NoDBBaseConstructor, unsigned short method_name)
 alternate constructor for base iterator classes constructed on the fly More...
 
virtual void derived_init_communicators (ParLevLIter pl_iter)
 derived class contributions to initializing the communicators associated with this Iterator instance
 
virtual const VariablesArray & initial_points () const
 gets the multiple initial points for this iterator. This will only be meaningful after a call to initial_points mutator.
 
StrStrSizet run_identifier () const
 get the unique run identifier based on method name, id, and number of executions
 

Protected Attributes

size_t numFunctions
 number of response functions
 
size_t numContinuousVars
 number of active continuous vars
 
size_t numDiscreteIntVars
 number of active discrete integer vars
 
size_t numDiscreteStringVars
 number of active discrete string vars
 
size_t numDiscreteRealVars
 number of active discrete real vars
 
bool compactMode
 switch for allSamples (compact mode) instead of allVariables (normal mode)
 
VariablesArray allVariables
 array of all variables to be evaluated in evaluate_parameter_sets()
 
RealMatrix allSamples
 compact alternative to allVariables
 
IntResponseMap allResponses
 array of all responses to be computed in evaluate_parameter_sets()
 
StringArray allHeaders
 array of headers to insert into output while evaluating allVariables
 
size_t numObjFns
 number of objective functions
 
size_t numLSqTerms
 number of least squares terms
 
RealPairPRPMultiMap bestVarsRespMap
 map which stores best set of solutions
 
- Protected Attributes inherited from Iterator
ProblemDescDBprobDescDB
 class member reference to the problem description database More...
 
ParallelLibraryparallelLib
 class member reference to the parallel library
 
ParConfigLIter methodPCIter
 the active ParallelConfiguration used by this Iterator instance
 
Model iteratedModel
 the model to be iterated (for iterators and meta-iterators employing a single model instance)
 
size_t myModelLayers
 number of Models locally (in Iterator or derived classes) wrapped around the initially passed in Model
 
unsigned short methodName
 name of the iterator (the user's method spec)
 
Real convergenceTol
 iteration convergence tolerance
 
int maxIterations
 maximum number of iterations for the iterator
 
int maxFunctionEvals
 maximum number of fn evaluations for the iterator
 
int maxEvalConcurrency
 maximum number of concurrent model evaluations More...
 
ActiveSet activeSet
 the response data requirements on each function evaluation
 
size_t numFinalSolutions
 number of solutions to retain in best variables/response arrays
 
VariablesArray bestVariablesArray
 collection of N best solution variables found during the study; always in context of Model originally passed to the Iterator (any in-flight Recasts must be undone)
 
ResponseArray bestResponseArray
 collection of N best solution responses found during the study; always in context of Model originally passed to the Iterator (any in-flight Recasts must be undone)
 
bool subIteratorFlag
 flag indicating if this Iterator is a sub-iterator (NestedModel::subIterator or DataFitSurrModel::daceIterator)
 
SizetArray primaryACVarMapIndices
 "primary" all continuous variable mapping indices flowed down from higher level iteration
 
SizetArray primaryADIVarMapIndices
 "primary" all discrete int variable mapping indices flowed down from higher level iteration
 
SizetArray primaryADSVarMapIndices
 "primary" all discrete string variable mapping indices flowed down from higher level iteration
 
SizetArray primaryADRVarMapIndices
 "primary" all discrete real variable mapping indices flowed down from higher level iteration
 
ShortArray secondaryACVarMapTargets
 "secondary" all continuous variable mapping targets flowed down from higher level iteration
 
ShortArray secondaryADIVarMapTargets
 "secondary" all discrete int variable mapping targets flowed down from higher level iteration
 
ShortArray secondaryADSVarMapTargets
 "secondary" all discrete string variable mapping targets flowed down from higher level iteration
 
ShortArray secondaryADRVarMapTargets
 "secondary" all discrete real variable mapping targets flowed down from higher level iteration
 
short outputLevel
 output verbosity level: {SILENT,QUIET,NORMAL,VERBOSE,DEBUG}_OUTPUT
 
bool summaryOutputFlag
 flag for summary output (evaluation stats, final results); default true, but false for on-the-fly (helper) iterators and sub-iterator use cases
 
ResultsManagerresultsDB
 reference to the global iterator results database
 
ResultsNames resultsNames
 valid names for iterator results
 

Private Member Functions

void compute_best_metrics (const Response &response, std::pair< Real, Real > &metrics)
 compares current evaluation to best evaluation and updates best
 
void update_best (const Variables &vars, int eval_id, const Response &response)
 compares current evaluation to best evaluation and updates best
 
void update_best (const Real *sample_c_vars, int eval_id, const Response &response)
 compares current evaluation to best evaluation and updates best
 

Private Attributes

int writePrecision
 write precision as specified by the user
 
Real vbdDropTol
 tolerance for omitting output of small VBD indices
 
RealVectorArray S4
 VBD main effect indices.
 
RealVectorArray T4
 VBD total effect indices.
 

Additional Inherited Members

- Static Protected Member Functions inherited from Iterator
static void gnewton_set_recast (const Variables &recast_vars, const ActiveSet &recast_set, ActiveSet &sub_model_set)
 conversion of request vector values for the Gauss-Newton Hessian approximation More...
 

Detailed Description

Base class for NonD, DACE, and ParamStudy branches of the iterator hierarchy.

The Analyzer class provides common data and functionality for various types of systems analysis, including nondeterministic analysis, design of experiments, and parameter studies.

Member Function Documentation

int num_samples ( ) const
inlinevirtual
void sample_to_variables ( const Real *  sample_c_vars,
Variables vars 
)
protectedvirtual
void initialize_run ( )
protectedvirtual

utility function to perform common operations prior to pre_run(); typically memory initialization; setting of instance pointers

Perform initialization phases of run sequence, like allocating memory and setting instance pointers. Commonly used in sub-iterator executions. This is a virtual function; when re-implementing, a derived class must call its nearest parent's initialize_run(), typically before performing its own implementation steps.

Reimplemented from Iterator.

Reimplemented in NonD.

References Model::initialize_mapping(), Model::is_null(), Iterator::iteratedModel, Model::mapping_initialized(), Iterator::methodPCIter, Analyzer::resize(), Model::set_evaluation_reference(), and Iterator::summaryOutputFlag.

Referenced by NonD::initialize_run().

void pre_run ( )
protectedvirtual

pre-run portion of run (optional); re-implemented by Iterators which can generate all Variables (parameter sets) a priori

pre-run phase, which a derived iterator may optionally reimplement; when not present, pre-run is likely integrated into the derived run function. This is a virtual function; when re-implementing, a derived class must call its nearest parent's pre_run(), if implemented, typically before performing its own implementation steps.

Reimplemented from Iterator.

Reimplemented in NonDLHSSampling, DDACEDesignCompExp, NonDRKDDarts, FSUDesignCompExp, ParamStudy, NonDMultilevelSampling, and PSUADEDesignCompExp.

References Analyzer::bestVarsRespMap.

Referenced by NonDMultilevelSampling::pre_run(), PSUADEDesignCompExp::pre_run(), ParamStudy::pre_run(), FSUDesignCompExp::pre_run(), NonDRKDDarts::pre_run(), DDACEDesignCompExp::pre_run(), and NonDLHSSampling::pre_run().

void post_run ( std::ostream &  s)
protectedvirtual

post-run portion of run (optional); verbose to print results; re-implemented by Iterators that can read all Variables/Responses and perform final analysis phase in a standalone way

Post-run phase, which a derived iterator may optionally reimplement; when not present, post-run is likely integrated into run. This is a virtual function; when re-implementing, a derived class must call its nearest parent's post_run(), typically after performing its own implementation steps.

Reimplemented from Iterator.

Reimplemented in NonDRKDDarts, NonDLHSSampling, DDACEDesignCompExp, FSUDesignCompExp, ParamStudy, PSUADEDesignCompExp, and NonDMultilevelSampling.

References Model::is_null(), Iterator::iteratedModel, Model::print_evaluation_summary(), Analyzer::print_results(), Iterator::resultsDB, Iterator::summaryOutputFlag, and ResultsManager::write_databases().

Referenced by NonDMultilevelSampling::post_run(), PSUADEDesignCompExp::post_run(), ParamStudy::post_run(), FSUDesignCompExp::post_run(), DDACEDesignCompExp::post_run(), NonDLHSSampling::post_run(), and NonDRKDDarts::post_run().

void finalize_run ( )
inlineprotectedvirtual

utility function to perform common operations following post_run(); deallocation and resetting of instance pointers

Optional: perform finalization phases of run sequence, like deallocating memory and resetting instance pointers. Commonly used in sub-iterator executions. This is a virtual function; when re-implementing, a derived class must call its nearest parent's finalize_run(), typically after performing its own implementation steps.

Reimplemented from Iterator.

Reimplemented in NonD.

References Iterator::finalize_run().

void pre_output ( )
protectedvirtual
void print_results ( std::ostream &  s)
protectedvirtual
const Model & algorithm_space_model ( ) const
inlineprotectedvirtual

default definition that gets redefined in selected derived Minimizers

Reimplemented from Iterator.

Reimplemented in NonDBayesCalibration, NonDExpansion, NonDGlobalInterval, and NonDReliability.

References Iterator::iteratedModel.

void evaluate_parameter_sets ( Model model,
bool  log_resp_flag,
bool  log_best_flag 
)
protected
void variance_based_decomp ( int  ncont,
int  ndiscint,
int  ndiscreal,
int  num_samples 
)
protected

Calculation of sensitivity indices obtained by variance based decomposition. These indices are obtained by the Saltelli version of the Sobol VBD which uses (K+2)*N function evaluations, where K is the number of dimensions (uncertain vars) and N is the number of samples.

References Dakota::abort_handler(), Analyzer::allResponses, Analyzer::allSamples, Analyzer::allVariables, Analyzer::compactMode, Variables::continuous_variables(), Dakota::copy_data(), Variables::discrete_int_variables(), Variables::discrete_real_variables(), Analyzer::evaluate_parameter_sets(), Analyzer::get_parameter_sets(), Iterator::iteratedModel, Analyzer::num_samples(), Analyzer::numFunctions, Analyzer::S4, Analyzer::T4, and Analyzer::vary_pattern().

Referenced by FSUDesignCompExp::core_run(), DDACEDesignCompExp::core_run(), and NonDLHSSampling::core_run().

void read_variables_responses ( int  num_evals,
size_t  num_vars 
)
protected
void print_sobol_indices ( std::ostream &  s) const
protected
void variables_to_sample ( const Variables vars,
Real *  sample_c_vars 
)
protectedvirtual

convert the active continuous variables into a column of allSamples

Default implementation maps active continuous variables only

Reimplemented in NonDSampling.

References Variables::continuous_variables(), and Analyzer::numContinuousVars.

Referenced by Analyzer::read_variables_responses(), and Analyzer::variables_array_to_samples().


The documentation for this class was generated from the following files: