Dakota  Version 6.20
Explore and Predict with Confidence
Public Member Functions | Public Attributes | List of all members
C3FnTrainData Class Reference

Handle for reference-counted pointer to C3FnTrainDataRep body. More...

Public Member Functions

 C3FnTrainData ()
 default constructor
 
 C3FnTrainData (const C3FnTrainData &ftd)
 copy constructor
 
 ~C3FnTrainData ()
 destructor
 
C3FnTrainDataoperator= (const C3FnTrainData &ftd)
 assignment operator
 
C3FnTrainData copy () const
 perform a deep copy (copy ctor and operator= use shallow copies)
 
void swap (C3FnTrainData &ftd)
 swap ftdReps between two envelopes
 
void free_ft ()
 free FT storage for value, gradient, and Hessian expansions
 
void free_all ()
 augment free_ft() with derived functions and global sensitivities
 
void ft_derived_functions_init_null ()
 initialize derived funtions pointers to NULL
 
void ft_derived_functions_create (struct MultiApproxOpts *opts, size_t num_mom, Real round_tol)
 allocate derived funtions pointers (standard mode)
 
void ft_derived_functions_create_av (struct MultiApproxOpts *opts, const SizetArray &rand_indices, Real round_tol)
 allocate derived funtions pointers (all variables mode)
 
void ft_derived_functions_free ()
 deallocate derived funtions pointers
 
struct FunctionTrain * function_train ()
 get pointer to the FunctionTrain approximation
 
void function_train (struct FunctionTrain *ft)
 set pointer to the FunctionTrain approximation
 
struct FT1DArray * ft_gradient ()
 get pointer to the FunctionTrain gradient
 
void ft_gradient (struct FT1DArray *ftg)
 set pointer to the FunctionTrain gradient
 
struct FT1DArray * ft_hessian ()
 get pointer to the FunctionTrain Hessian
 
void ft_hessian (struct FT1DArray *fth)
 set pointer to the FunctionTrain Hessian
 
const struct FTDerivedFunctions & derived_functions ()
 return reference to the FTDerivedFunctions instance
 
struct C3SobolSensitivity * sobol ()
 get pointer to the Sobol' indices object
 
void sobol (struct C3SobolSensitivity *ss)
 set pointer to the Sobol' indices object
 
const UShortArray & recovered_orders () const
 
UShortArray & recovered_orders ()
 
void recovered_orders (const UShortArray &ft_orders)
 
const SizetVector & recovered_ranks () const
 
SizetVector & recovered_ranks ()
 
void recovered_ranks (const SizetVector &ft_ranks)
 
const RealVector & moments () const
 
RealVector & moments ()
 
Real moment (size_t i) const
 
void moment (Real mom, size_t i)
 

Public Attributes

std::shared_ptr< C3FnTrainDataRep > ftdRep
 (shared) pointer to body instance
 

Detailed Description

Handle for reference-counted pointer to C3FnTrainDataRep body.


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