Template implementation of function object in one dimension returning a constant value. More...

#include <JConstantFunction1D.hh>

Inheritance diagram for JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >:

Public Types
typedef JFunction1D< JArgument_t, JResult_t >	function_type

typedef function_type::argument_type	argument_type

typedef function_type::result_type	result_type

enum	{ NUMBER_OF_DIMENSIONS = 1 }

typedef JFunctional< JArgument_t, JResult_t >	functional_type

typedef functional_type::JExceptionHandler	JExceptionHandler

typedef JSupervisor	supervisor_type

Public Member Functions
	JConstantFunction1D ()
	Default constructor.

	JConstantFunction1D (const result_type y)
	Constructor.

	JConstantFunction1D (const JMATH::JZero &y)
	Constructor.

JConstantFunction1D &	add (typename JLANG::JClass< result_type >::argument_type value)
	Add offset.

JConstantFunction1D &	sub (typename JLANG::JClass< result_type >::argument_type value)
	Subtract offset.

JConstantFunction1D &	mul (const double value)
	Scale contents.

JConstantFunction1D &	div (const double value)
	Scale contents.

JConstantFunction1D &	add (const JConstantFunction1D &function)
	Add function.

JConstantFunction1D &	sub (const JConstantFunction1D &function)
	Subtract function.

result_type	getY () const
	Function value.

virtual result_type	evaluate (const argument_type *pX) const override
	Function value evaluation.

result_type	operator() (const argument_type x) const
	Function value evaluation.

const JSupervisor &	getSupervisor () const
	Get supervisor.

const JExceptionHandler &	getExceptionHandler () const override
	Get exception handler.

void	setExceptionHandler (const JSupervisor &supervisor)
	Set the supervisor for handling of exceptions.

Static Public Member Functions
static result_type	getValue (const JFunctional &function, const argument_type *pX)
	Recursive function value evaluation.

static JClass< result_type >::argument_type	getValue (typename JClass< result_type >::argument_type value, const argument_type *pX)
	Termination of recursive function value evaluation.

Protected Member Functions
virtual void	do_compile () override
	Function compilation.

Protected Attributes
JSupervisor	__supervisor

Private Attributes
result_type	__y

Friends
JReader &	operator>> (JReader &in, JConstantFunction1D &function)
	Read function from input.

JWriter &	operator<< (JWriter &out, const JConstantFunction1D &function)
	Write function to output.

Detailed Description

template<class JArgument_t, class JResult_t>
class JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >

Template implementation of function object in one dimension returning a constant value.

This class implements the JFunction1D interface.

Definition at line 26 of file JConstantFunction1D.hh.

Member Typedef Documentation

◆ function_type

template<class JArgument_t , class JResult_t >

JFunction1D<JArgument_t, JResult_t> JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::function_type

Definition at line 31 of file JConstantFunction1D.hh.

◆ argument_type

template<class JArgument_t , class JResult_t >

function_type::argument_type JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::argument_type

Definition at line 32 of file JConstantFunction1D.hh.

◆ result_type

template<class JArgument_t , class JResult_t >

function_type::result_type JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::result_type

Definition at line 33 of file JConstantFunction1D.hh.

◆ functional_type

template<class JArgument_t , class JResult_t >

JFunctional<JArgument_t, JResult_t> JTOOLS::JFunction1D< JArgument_t, JResult_t >::functional_type

inherited

Definition at line 332 of file JFunctional.hh.

◆ JExceptionHandler

template<class JArgument_t , class JResult_t >

functional_type::JExceptionHandler JTOOLS::JFunction< JArgument_t, JResult_t >::JExceptionHandler

inherited

Definition at line 235 of file JFunctional.hh.

◆ supervisor_type

template<class JArgument_t , class JResult_t >

JSupervisor JTOOLS::JFunction< JArgument_t, JResult_t >::supervisor_type

inherited

Definition at line 237 of file JFunctional.hh.

Member Enumeration Documentation

◆ anonymous enum

template<class JArgument_t , class JResult_t >

anonymous enum

inherited

Enumerator
NUMBER_OF_DIMENSIONS

Definition at line 330 of file JFunctional.hh.

330{ NUMBER_OF_DIMENSIONS = 1 };

JTOOLS::JFunction1D::NUMBER_OF_DIMENSIONS

@ NUMBER_OF_DIMENSIONS

Definition JFunctional.hh:330

Constructor & Destructor Documentation

◆ JConstantFunction1D() [1/3]

template<class JArgument_t , class JResult_t >

JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::JConstantFunction1D ( )

inline

Default constructor.

Definition at line 39 of file JConstantFunction1D.hh.

                          :
      function_type(),
      __y()
    {}

◆ JConstantFunction1D() [2/3]

template<class JArgument_t , class JResult_t >

JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::JConstantFunction1D ( const result_type y )

inline

Constructor.

Parameters

y value

Definition at line 50 of file JConstantFunction1D.hh.

                                             :
      function_type(),
      __y(y)
    {}

◆ JConstantFunction1D() [3/3]

template<class JArgument_t , class JResult_t >

JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::JConstantFunction1D ( const JMATH::JZero & y )

inline

Constructor.

Parameters

y zero

Definition at line 61 of file JConstantFunction1D.hh.

                                             :
      function_type(),
      __y(y)
    {}

Member Function Documentation

◆ add() [1/2]

template<class JArgument_t , class JResult_t >

JConstantFunction1D & JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::add ( typename JLANG::JClass< result_type >::argument_type value )

inline

Add offset.

Parameters

value offset

Definition at line 72 of file JConstantFunction1D.hh.

    {
      __y += value;
 
      return *this;
    }

◆ sub() [1/2]

template<class JArgument_t , class JResult_t >

JConstantFunction1D & JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::sub ( typename JLANG::JClass< result_type >::argument_type value )

inline

Subtract offset.

Parameters

value offset

Definition at line 85 of file JConstantFunction1D.hh.

    {
      __y -= value;
 
      return *this;
    }

◆ mul()

template<class JArgument_t , class JResult_t >

JConstantFunction1D & JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::mul ( const double value )

inline

Scale contents.

Parameters

value multiplication factor

Definition at line 98 of file JConstantFunction1D.hh.

    {
      __y *= value;
 
      return *this;
    }

◆ div()

template<class JArgument_t , class JResult_t >

JConstantFunction1D & JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::div ( const double value )

inline

Scale contents.

Parameters

value division factor

Definition at line 111 of file JConstantFunction1D.hh.

    {
      __y /= value;
 
      return *this;
    }

◆ add() [2/2]

template<class JArgument_t , class JResult_t >

JConstantFunction1D & JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::add ( const JConstantFunction1D< JArgument_t, JResult_t > & function )

inline

Add function.

Parameters

function function

Definition at line 124 of file JConstantFunction1D.hh.

    {
      __y += function.getY();
 
      return *this;
    }

◆ sub() [2/2]

template<class JArgument_t , class JResult_t >

JConstantFunction1D & JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::sub ( const JConstantFunction1D< JArgument_t, JResult_t > & function )

inline

Subtract function.

Parameters

function function

Definition at line 137 of file JConstantFunction1D.hh.

    {
      __y -= function.getY();
 
      return *this;
    }

◆ getY()

template<class JArgument_t , class JResult_t >

result_type JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::getY ( ) const

inline

Function value.

Returns: function value

Definition at line 150 of file JConstantFunction1D.hh.

    {
      return __y;
    }

◆ evaluate()

template<class JArgument_t , class JResult_t >

virtual result_type JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::evaluate ( const argument_type * pX ) const

inlineoverridevirtual

Function value evaluation.

Parameters

pX	pointer to abscissa values

Returns: function value

Implements JTOOLS::JFunctional< JArgument_t, JResult_t >.

Definition at line 162 of file JConstantFunction1D.hh.

    {
      return __y;
    }

◆ do_compile()

template<class JArgument_t , class JResult_t >

virtual void JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::do_compile ( )

inlineoverrideprotectedvirtual

Function compilation.

Definition at line 198 of file JConstantFunction1D.hh.

199 {}

◆ operator()()

template<class JArgument_t , class JResult_t >

result_type JTOOLS::JFunction1D< JArgument_t, JResult_t >::operator() ( const argument_type x ) const

inlineinherited

Function value evaluation.

Parameters

x	argument value

Returns: function value

Definition at line 343 of file JFunctional.hh.

    {
      return this->evaluate(&x);
    }

◆ getSupervisor()

template<class JArgument_t , class JResult_t >

const JSupervisor & JTOOLS::JFunction< JArgument_t, JResult_t >::getSupervisor ( ) const

inlineinherited

Get supervisor.

Returns: supervisor

Definition at line 290 of file JFunctional.hh.

    {
      return __supervisor;
    }

◆ getExceptionHandler()

template<class JArgument_t , class JResult_t >

const JExceptionHandler & JTOOLS::JFunction< JArgument_t, JResult_t >::getExceptionHandler ( ) const

inlineoverridevirtualinherited

Get exception handler.

Returns: exception handler

Implements JTOOLS::JFunctional< JArgument_t, JResult_t >.

Definition at line 301 of file JFunctional.hh.

    {
      return *__supervisor.handler;
    }

◆ setExceptionHandler()

template<class JArgument_t , class JResult_t >

void JTOOLS::JFunction< JArgument_t, JResult_t >::setExceptionHandler ( const JSupervisor & supervisor )

inlineinherited

Set the supervisor for handling of exceptions.

Parameters

supervisor supervisor

Definition at line 312 of file JFunctional.hh.

    {
      this->__supervisor = supervisor;
    }

◆ getValue() [1/2]

template<class JArgument_t , class JResult_t >

static result_type JTOOLS::JFunctional< JArgument_t, JResult_t >::getValue	(	const JFunctional< JArgument_t, JResult_t > &	function,
		const argument_type *	pX )

inlinestaticinherited

Recursive function value evaluation.

Parameters

function	function
pX	pointer to abscissa values

Definition at line 103 of file JFunctional.hh.

    {
      return function.evaluate(pX);
    }

◆ getValue() [2/2]

template<class JArgument_t , class JResult_t >

static JClass< result_type >::argument_type JTOOLS::JFunctional< JArgument_t, JResult_t >::getValue	(	typename JClass< result_type >::argument_type	value,
		const argument_type *	pX )

inlinestaticinherited

Termination of recursive function value evaluation.

Parameters

value	result
pX	pointer to abscissa values

Definition at line 117 of file JFunctional.hh.

    {
      return value;
    }

Friends And Related Symbol Documentation

◆ operator>>

template<class JArgument_t , class JResult_t >

JReader & operator>>	(	JReader &	in,
		JConstantFunction1D< JArgument_t, JResult_t > &	function )

friend

Read function from input.

Parameters

in	reader
function	function

Returns: reader

Definition at line 175 of file JConstantFunction1D.hh.

    {
      return in >> function.__y;
    }

◆ operator<<

template<class JArgument_t , class JResult_t >

JWriter & operator<<	(	JWriter &	out,
		const JConstantFunction1D< JArgument_t, JResult_t > &	function )

friend

Write function to output.

Parameters

out	writer
function	function

Returns: writer

Definition at line 188 of file JConstantFunction1D.hh.

    {
      return out << function.__y;
    }

Member Data Documentation

◆ __y

template<class JArgument_t , class JResult_t >

result_type JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >::__y

private

Definition at line 202 of file JConstantFunction1D.hh.

◆ __supervisor

template<class JArgument_t , class JResult_t >

JSupervisor JTOOLS::JFunction< JArgument_t, JResult_t >::__supervisor

protectedinherited

Definition at line 318 of file JFunctional.hh.

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

JConstantFunction1D.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ function_type

◆ argument_type

◆ result_type

◆ functional_type

◆ JExceptionHandler

◆ supervisor_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ JConstantFunction1D() [1/3]

◆ JConstantFunction1D() [2/3]

◆ JConstantFunction1D() [3/3]

Member Function Documentation

◆ add() [1/2]

◆ sub() [1/2]

◆ mul()

◆ div()

◆ add() [2/2]

◆ sub() [2/2]

◆ getY()

◆ evaluate()

◆ do_compile()

◆ operator()()

◆ getSupervisor()

◆ getExceptionHandler()

◆ setExceptionHandler()

◆ getValue() [1/2]

◆ getValue() [2/2]

Friends And Related Symbol Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ __y

◆ __supervisor