olb::opti::projection::GiBase< T, DESCRIPTOR > Struct Template Reference

Gridterm-dependent projection base class. More...

#include <projection.h>

Inheritance diagram for olb::opti::projection::GiBase< T, DESCRIPTOR >:

Collaboration diagram for olb::opti::projection::GiBase< T, DESCRIPTOR >:

Public Member Functions
	GiBase (const UnitConverter< T, DESCRIPTOR > &converter)
virtual T	subprojection (T x) const =0
virtual T	derivSubprojection (T x) const =0
virtual T	inverseSubprojection (T x) const =0
T	project (T x) const override
T	derivative (T x) const override
T	inverse (T x) const override

Public Attributes
const T	_gridTerm

Detailed Description

template<typename T, typename DESCRIPTOR>
struct olb::opti::projection::GiBase< T, DESCRIPTOR >

Gridterm-dependent projection base class.

Projection = 1 - gridTerm / K(x) with K(x) = subprojection(x) + gridTerm

Definition at line 235 of file projection.h.

Constructor & Destructor Documentation

GiBase()

template<typename T , typename DESCRIPTOR >

olb::opti::projection::GiBase< T, DESCRIPTOR >::GiBase ( const UnitConverter< T, DESCRIPTOR > & converter )

inline

Definition at line 239 of file projection.h.

   : _gridTerm {gridTerm(converter)}
  { }

Member Function Documentation

derivative()

template<typename T , typename DESCRIPTOR >

T olb::opti::projection::GiBase< T, DESCRIPTOR >::derivative ( T x ) const

inlineoverridevirtual

Implements olb::opti::projection::Base< T >.

Definition at line 250 of file projection.h.

                                   {
    const T y = subprojection(x) + _gridTerm;
    return _gridTerm*derivSubprojection(x) / (y*y);
  }

References olb::opti::projection::GiBase< T, DESCRIPTOR >::_gridTerm, olb::opti::projection::GiBase< T, DESCRIPTOR >::derivSubprojection(), and olb::opti::projection::GiBase< T, DESCRIPTOR >::subprojection().

Here is the call graph for this function:

derivSubprojection()

template<typename T , typename DESCRIPTOR >

virtual T olb::opti::projection::GiBase< T, DESCRIPTOR >::derivSubprojection ( T x ) const

pure virtual

Implemented in olb::opti::projection::Foerster< T, DESCRIPTOR >, olb::opti::projection::FoersterN< T, DESCRIPTOR >, and olb::opti::projection::StasiusN< T, DESCRIPTOR >.

Here is the caller graph for this function:

inverse()

template<typename T , typename DESCRIPTOR >

T olb::opti::projection::GiBase< T, DESCRIPTOR >::inverse ( T x ) const

inlineoverridevirtual

Implements olb::opti::projection::Base< T >.

Definition at line 254 of file projection.h.

                                {
    return inverseSubprojection(_gridTerm*x/(T(1)-x));
  }

References olb::opti::projection::GiBase< T, DESCRIPTOR >::_gridTerm, and olb::opti::projection::GiBase< T, DESCRIPTOR >::inverseSubprojection().

Here is the call graph for this function:

inverseSubprojection()

template<typename T , typename DESCRIPTOR >

virtual T olb::opti::projection::GiBase< T, DESCRIPTOR >::inverseSubprojection ( T x ) const

pure virtual

Implemented in olb::opti::projection::Foerster< T, DESCRIPTOR >, olb::opti::projection::FoersterN< T, DESCRIPTOR >, and olb::opti::projection::StasiusN< T, DESCRIPTOR >.

Here is the caller graph for this function:

project()

template<typename T , typename DESCRIPTOR >

T olb::opti::projection::GiBase< T, DESCRIPTOR >::project ( T x ) const

inlineoverridevirtual

Implements olb::opti::projection::Base< T >.

Definition at line 247 of file projection.h.

                                {
    return subprojection(x) / (subprojection(x) + _gridTerm);
  }

References olb::opti::projection::GiBase< T, DESCRIPTOR >::_gridTerm, and olb::opti::projection::GiBase< T, DESCRIPTOR >::subprojection().

Here is the call graph for this function:

subprojection()

template<typename T , typename DESCRIPTOR >

virtual T olb::opti::projection::GiBase< T, DESCRIPTOR >::subprojection ( T x ) const

pure virtual

Implemented in olb::opti::projection::Foerster< T, DESCRIPTOR >, olb::opti::projection::FoersterN< T, DESCRIPTOR >, and olb::opti::projection::StasiusN< T, DESCRIPTOR >.

Here is the caller graph for this function:

Member Data Documentation

_gridTerm

template<typename T , typename DESCRIPTOR >

const T olb::opti::projection::GiBase< T, DESCRIPTOR >::_gridTerm

Definition at line 237 of file projection.h.

---

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

• src/optimization/projection.h