OptimizableInterface< Real > Class Template Referenceabstract

OptimizableInterface provides a virtual class for optimizable objects. More...

#include <optimizable-itf.h>

Public Member Functions

virtual void ComputeGradient (const Vector< Real > &params, Vector< Real > *gradient_out)=0
 computes gradient for a parameter params and returns it in gradient_out More...
 
virtual Real ComputeValue (const Vector< Real > &params)=0
 computes the function value for a parameter params and returns it More...
 
virtual ~OptimizableInterface ()
 

Detailed Description

template<class Real>
class kaldi::OptimizableInterface< Real >

OptimizableInterface provides a virtual class for optimizable objects.

E.g. a class that computed a likelihood function and its gradient using some parameter that has to be optimized on data could inherit from it.

Definition at line 36 of file optimizable-itf.h.

Constructor & Destructor Documentation

◆ ~OptimizableInterface()

virtual ~OptimizableInterface ( )
inlinevirtual

Definition at line 46 of file optimizable-itf.h.

46 {}

Member Function Documentation

◆ ComputeGradient()

virtual void ComputeGradient ( const Vector< Real > &  params,
Vector< Real > *  gradient_out 
)
pure virtual

computes gradient for a parameter params and returns it in gradient_out

◆ ComputeValue()

virtual Real ComputeValue ( const Vector< Real > &  params)
pure virtual

computes the function value for a parameter params and returns it


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