RVL::RVLBoxMaxStep< Scalar > Class Template Reference

Given a maximum and minimum vectors which define a box constraint, find the largest scalar so that $x+\alpha dx$ is not outside the box. More...

#include <functions.hh>

Inheritance diagram for RVL::RVLBoxMaxStep< Scalar >:

RVL::QuaternaryLocalFunctionObjectScalarRedn< Scalar, Scalar > RVL::FunctionObjectScalarRedn< Scalar > RVL::QuaternaryLocalConstEval< Scalar > RVL::FunctionObjectConstEval RVL::ScalarRedn< Scalar > RVL::LocalConstEval< Scalar > RVL::Writeable List of all members.

Public Member Functions

 RVLBoxMaxStep ()
 RVLBoxMaxStep (const RVLBoxMaxStep< Scalar > &b)
 ~RVLBoxMaxStep ()
void operator() (LocalDataContainer< Scalar > const &x, LocalDataContainer< Scalar > const &dx, LocalDataContainer< Scalar > const &xmin, LocalDataContainer< Scalar > const &xmax)
string getName () const

Detailed Description

template<class Scalar>
class RVL::RVLBoxMaxStep< Scalar >

Given a maximum and minimum vectors which define a box constraint, find the largest scalar so that $x+\alpha dx$ is not outside the box.

Definition at line 764 of file functions.hh.


Constructor & Destructor Documentation

template<class Scalar>
RVL::RVLBoxMaxStep< Scalar >::RVLBoxMaxStep (  ) 

Definition at line 768 of file functions.hh.

template<class Scalar>
RVL::RVLBoxMaxStep< Scalar >::RVLBoxMaxStep ( const RVLBoxMaxStep< Scalar > &  b  ) 

Definition at line 769 of file functions.hh.

template<class Scalar>
RVL::RVLBoxMaxStep< Scalar >::~RVLBoxMaxStep (  ) 

Definition at line 770 of file functions.hh.


Member Function Documentation

template<class Scalar>
void RVL::RVLBoxMaxStep< Scalar >::operator() ( LocalDataContainer< Scalar > const &  x,
LocalDataContainer< Scalar > const &  dx,
LocalDataContainer< Scalar > const &  xmin,
LocalDataContainer< Scalar > const &  xmax 
) [virtual]

Implements RVL::QuaternaryLocalConstEval< Scalar >.

Definition at line 773 of file functions.hh.

References RVL::LocalDataContainer< DataType >::getData(), RVL::LocalDataContainer< DataType >::getSize(), and RVL::ScalarRedn< Scalar >::setValue().

template<class Scalar>
string RVL::RVLBoxMaxStep< Scalar >::getName (  )  const [virtual]

Implements RVL::FunctionObjectConstEval.

Definition at line 815 of file functions.hh.


The documentation for this class was generated from the following file:
Generated on 5 Jan 2017 for LocalRVL by  doxygen 1.4.7