ReFRACtor
FullPhysics::ConnorCostFunction Class Reference

#include <connor_cost_function.h>

+ Inheritance diagram for FullPhysics::ConnorCostFunction:
+ Collaboration diagram for FullPhysics::ConnorCostFunction:

Public Member Functions

 ConnorCostFunction (const boost::shared_ptr< StateVector > &Sv, const boost::shared_ptr< ForwardModel > &fm, const boost::shared_ptr< Observation > &inst_meas)
 
virtual ~ConnorCostFunction ()
 
virtual void cost_function (const blitz::Array< double, 1 > &X, blitz::Array< double, 1 > &Residual, blitz::Array< double, 1 > &Se, blitz::Array< double, 2 > &Jacobian) const
 For the given value of X, calculate the residuals and jacobians. More...
 
virtual void print (std::ostream &Os) const
 Print description of object. More...
 
std::string print_to_string () const
 Print to string. More...
 

Detailed Description

Definition at line 10 of file connor_cost_function.h.

Constructor & Destructor Documentation

◆ ConnorCostFunction()

FullPhysics::ConnorCostFunction::ConnorCostFunction ( const boost::shared_ptr< StateVector > &  Sv,
const boost::shared_ptr< ForwardModel > &  fm,
const boost::shared_ptr< Observation > &  inst_meas 
)
inline

Definition at line 12 of file connor_cost_function.h.

◆ ~ConnorCostFunction()

virtual FullPhysics::ConnorCostFunction::~ConnorCostFunction ( )
inlinevirtual

Definition at line 19 of file connor_cost_function.h.

Member Function Documentation

◆ cost_function()

virtual void FullPhysics::ConnorCostFunction::cost_function ( const blitz::Array< double, 1 > &  X,
blitz::Array< double, 1 > &  Residual,
blitz::Array< double, 1 > &  Se,
blitz::Array< double, 2 > &  Jacobian 
) const
inlinevirtual

For the given value of X, calculate the residuals and jacobians.

The residual is defined as F(x) - y, so the Jacobian of the residuals is the same as the Jacobian of F(x).

Parameters
XInput value
ResidualOn exit, set to the residual of the cost function
SeOn exit, the covariance of the residual. We assume the covariance is a diagonal matrix, and just return the diagonal elements
JacobianOn exit, the Jacobian of the cost function.

Implements FullPhysics::CostFunction.

Definition at line 20 of file connor_cost_function.h.

◆ print()

virtual void FullPhysics::ConnorCostFunction::print ( std::ostream &  Os) const
inlinevirtual

Print description of object.

Reimplemented from FullPhysics::CostFunction.

Definition at line 41 of file connor_cost_function.h.

◆ print_to_string()

std::string FullPhysics::Printable< CostFunction >::print_to_string ( ) const
inlineinherited

Print to string.

This is primarily useful for SWIG wrappers to this class, e.g. a to_s method in ruby.

Definition at line 31 of file printable.h.


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

Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:12