MUQ  0.4.3
Public Member Functions | List of all members
umbridge::Model Class Referenceabstract

#include <umbridge.h>

Inheritance diagram for umbridge::Model:
[legend]

Detailed Description

Definition at line 19 of file umbridge.h.

Public Member Functions

 Model (std::string name)
 
virtual std::vector< std::size_t > GetInputSizes (const json &config_json=json()) const =0
 
virtual std::vector< std::size_t > GetOutputSizes (const json &config_json=json()) const =0
 
virtual std::vector< std::vector< double > > Evaluate (const std::vector< std::vector< double >> &inputs, json config_json=json())
 
virtual std::vector< double > Gradient (unsigned int outWrt, unsigned int inWrt, const std::vector< std::vector< double >> &inputs, const std::vector< double > &sens, json config_json=json())
 
virtual std::vector< double > ApplyJacobian (unsigned int outWrt, unsigned int inWrt, const std::vector< std::vector< double >> &inputs, const std::vector< double > &vec, json config_json=json())
 
virtual std::vector< double > ApplyHessian (unsigned int outWrt, unsigned int inWrt1, unsigned int inWrt2, const std::vector< std::vector< double >> &inputs, const std::vector< double > &sens, const std::vector< double > &vec, json config_json=json())
 
virtual bool SupportsEvaluate ()
 
virtual bool SupportsGradient ()
 
virtual bool SupportsApplyJacobian ()
 
virtual bool SupportsApplyHessian ()
 
std::string GetName () const
 

Constructor & Destructor Documentation

◆ Model()

umbridge::Model::Model ( std::string  name)
inline

Definition at line 21 of file umbridge.h.

Member Function Documentation

◆ ApplyHessian()

virtual std::vector<double> umbridge::Model::ApplyHessian ( unsigned int  outWrt,
unsigned int  inWrt1,
unsigned int  inWrt2,
const std::vector< std::vector< double >> &  inputs,
const std::vector< double > &  sens,
const std::vector< double > &  vec,
json  config_json = json() 
)
inlinevirtual

Reimplemented in umbridge::HTTPModel, and muq::Modeling::UMBridgeModPieceWrapper.

Definition at line 50 of file umbridge.h.

Referenced by umbridge::serveModels().

◆ ApplyJacobian()

virtual std::vector<double> umbridge::Model::ApplyJacobian ( unsigned int  outWrt,
unsigned int  inWrt,
const std::vector< std::vector< double >> &  inputs,
const std::vector< double > &  vec,
json  config_json = json() 
)
inlinevirtual

Reimplemented in umbridge::HTTPModel, and muq::Modeling::UMBridgeModPieceWrapper.

Definition at line 41 of file umbridge.h.

Referenced by umbridge::serveModels().

◆ Evaluate()

virtual std::vector<std::vector<double> > umbridge::Model::Evaluate ( const std::vector< std::vector< double >> &  inputs,
json  config_json = json() 
)
inlinevirtual

Reimplemented in umbridge::HTTPModel, and muq::Modeling::UMBridgeModPieceWrapper.

Definition at line 26 of file umbridge.h.

Referenced by umbridge::serveModels().

◆ GetInputSizes()

virtual std::vector<std::size_t> umbridge::Model::GetInputSizes ( const json &  config_json = json()) const
pure virtual

Implemented in muq::Modeling::UMBridgeModPieceWrapper, and umbridge::HTTPModel.

Referenced by umbridge::check_input_sizes(), umbridge::check_input_wrt(), umbridge::check_vector_size(), and umbridge::serveModels().

◆ GetName()

std::string umbridge::Model::GetName ( ) const
inline

Definition at line 66 of file umbridge.h.

References name.

◆ GetOutputSizes()

virtual std::vector<std::size_t> umbridge::Model::GetOutputSizes ( const json &  config_json = json()) const
pure virtual

Implemented in muq::Modeling::UMBridgeModPieceWrapper, and umbridge::HTTPModel.

Referenced by umbridge::check_input_sizes(), umbridge::check_output_sizes(), umbridge::check_output_wrt(), umbridge::check_sensitivity_size(), and umbridge::serveModels().

◆ Gradient()

virtual std::vector<double> umbridge::Model::Gradient ( unsigned int  outWrt,
unsigned int  inWrt,
const std::vector< std::vector< double >> &  inputs,
const std::vector< double > &  sens,
json  config_json = json() 
)
inlinevirtual

Reimplemented in umbridge::HTTPModel, and muq::Modeling::UMBridgeModPieceWrapper.

Definition at line 32 of file umbridge.h.

Referenced by umbridge::serveModels().

◆ SupportsApplyHessian()

virtual bool umbridge::Model::SupportsApplyHessian ( )
inlinevirtual

Reimplemented in muq::Modeling::UMBridgeModPieceWrapper, and umbridge::HTTPModel.

Definition at line 64 of file umbridge.h.

Referenced by umbridge::serveModels().

◆ SupportsApplyJacobian()

virtual bool umbridge::Model::SupportsApplyJacobian ( )
inlinevirtual

Reimplemented in muq::Modeling::UMBridgeModPieceWrapper, and umbridge::HTTPModel.

Definition at line 63 of file umbridge.h.

Referenced by umbridge::serveModels().

◆ SupportsEvaluate()

virtual bool umbridge::Model::SupportsEvaluate ( )
inlinevirtual

Reimplemented in muq::Modeling::UMBridgeModPieceWrapper, and umbridge::HTTPModel.

Definition at line 61 of file umbridge.h.

Referenced by umbridge::serveModels().

◆ SupportsGradient()

virtual bool umbridge::Model::SupportsGradient ( )
inlinevirtual

Reimplemented in muq::Modeling::UMBridgeModPieceWrapper, and umbridge::HTTPModel.

Definition at line 62 of file umbridge.h.

Referenced by umbridge::serveModels().

Member Data Documentation

◆ name

std::string umbridge::Model::name
protected

Definition at line 69 of file umbridge.h.

Referenced by umbridge::HTTPModel::ApplyHessian(), umbridge::HTTPModel::ApplyJacobian(), umbridge::HTTPModel::Evaluate(), umbridge::HTTPModel::GetInputSizes(), GetName(), umbridge::HTTPModel::GetOutputSizes(), umbridge::HTTPModel::Gradient(), and umbridge::HTTPModel::HTTPModel().

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