cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Static Public Member Functions | List of all members
vctBinaryOperations< _outputType, _input1Type, _input2Type >::ClipIn Class Reference

Return the -input2 in input1 is lesser than -input2, input2 if input 1 is greater than input2 and input1 otherwise. The operator doesn't test if input2 is negative. More...

#include <vctBinaryOperations.h>

Public Types

typedef _outputType OutputType
 

Static Public Member Functions

static const OutputType Operate (const OutputType &bound, const OutputType &input)
 
static OutputType NeutralElement (void)
 

Detailed Description

template<class _outputType, class _input1Type = _outputType, class _input2Type = _outputType>
class vctBinaryOperations< _outputType, _input1Type, _input2Type >::ClipIn

Return the -input2 in input1 is lesser than -input2, input2 if input 1 is greater than input2 and input1 otherwise. The operator doesn't test if input2 is negative.

See Also
vctBinaryOperations input1 capped in range [-input2, input2]. Note that here all arguments are of the same type, because they have to be compared.

Member Typedef Documentation

template<class _outputType , class _input1Type = _outputType, class _input2Type = _outputType>
typedef _outputType vctBinaryOperations< _outputType, _input1Type, _input2Type >::ClipIn::OutputType

Member Function Documentation

template<class _outputType , class _input1Type = _outputType, class _input2Type = _outputType>
static OutputType vctBinaryOperations< _outputType, _input1Type, _input2Type >::ClipIn::NeutralElement ( void  )
inlinestatic
template<class _outputType , class _input1Type = _outputType, class _input2Type = _outputType>
static const OutputType vctBinaryOperations< _outputType, _input1Type, _input2Type >::ClipIn::Operate ( const OutputType bound,
const OutputType input 
)
inlinestatic

Execute the operation.

Parameters
input1First operand.
input2Second operand.

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