Jpp 19.3.0-rc.2
the software that should make you happy
Loading...
Searching...
No Matches
JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer Class Reference

Default implementation of weight application and coordinate transformation of function. More...

#include <JMultiMapTransformer.hh>

Inheritance diagram for JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer:
JTOOLS::JMultiMapTransformer< N, JArgument_t > JLANG::JClonable< JClonable_t, JDerived_t > JIO::JSerialisable

Public Types

typedef JMultiMapTransformer< N, JArgument_t > multimaptransformer_type
 
typedef JClonable< multimaptransformer_type >::clone_type clone_type
 
typedef JArgument_t argument_type
 
typedef JArray< N, argument_typearray_type
 
typedef const JArray< N, const argument_typeconst_array_type
 

Public Member Functions

 JMultiMapDefaultTransformer ()
 Default constructor.
 
virtual clone_type clone () const override
 Clone object.
 
virtual argument_type putXn (const_array_type &buffer, const argument_type xn) const override
 Evaluate xn value as a function of {x0, ..., xn-1}.
 
virtual argument_type getXn (const_array_type &buffer, const argument_type xn) const override
 Evaluate xn value as a function of {x0, ..., xn-1}.
 
virtual double getWeight (const_array_type &buffer) const override
 Weight function.
 
virtual JReaderread (JReader &in) override
 Read from input.
 
virtual JWriterwrite (JWriter &out) const override
 Write to output.
 
template<class ... Args>
double getWeight (const argument_type x, const Args &...args) const
 Weight function.
 

Static Public Member Functions

static const JMultiMapTransformergetDefaultTransformer ()
 Get default transformer.
 
static JMultiMapTransformergetClone ()
 Get clone of default transformer.
 

Detailed Description

template<unsigned int N, class JArgument_t>
class JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer

Default implementation of weight application and coordinate transformation of function.

The coordiniate transformation has no effect and the weight is equal to one.

This class implements the JMultiMapTransformer, JClonable and JSerialisable interfaces.

Definition at line 129 of file JMultiMapTransformer.hh.

Member Typedef Documentation

◆ multimaptransformer_type

template<unsigned int N, class JArgument_t >
JMultiMapTransformer<N, JArgument_t> JTOOLS::JMultiMapTransformer< N, JArgument_t >::multimaptransformer_type
inherited

Definition at line 39 of file JMultiMapTransformer.hh.

◆ clone_type

template<unsigned int N, class JArgument_t >
JClonable<multimaptransformer_type>::clone_type JTOOLS::JMultiMapTransformer< N, JArgument_t >::clone_type
inherited

Definition at line 41 of file JMultiMapTransformer.hh.

◆ argument_type

template<unsigned int N, class JArgument_t >
JArgument_t JTOOLS::JMultiMapTransformer< N, JArgument_t >::argument_type
inherited

Definition at line 42 of file JMultiMapTransformer.hh.

◆ array_type

template<unsigned int N, class JArgument_t >
JArray<N, argument_type> JTOOLS::JMultiMapTransformer< N, JArgument_t >::array_type
inherited

Definition at line 43 of file JMultiMapTransformer.hh.

◆ const_array_type

template<unsigned int N, class JArgument_t >
const JArray<N, const argument_type> JTOOLS::JMultiMapTransformer< N, JArgument_t >::const_array_type
inherited

Definition at line 44 of file JMultiMapTransformer.hh.

Constructor & Destructor Documentation

◆ JMultiMapDefaultTransformer()

template<unsigned int N, class JArgument_t >
JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer::JMultiMapDefaultTransformer ( )
inline

Default constructor.

Definition at line 137 of file JMultiMapTransformer.hh.

138 {}

Member Function Documentation

◆ clone()

template<unsigned int N, class JArgument_t >
virtual clone_type JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer::clone ( ) const
inlineoverridevirtual

Clone object.

Returns
pointer to newly created transformer

Reimplemented from JLANG::JClonable< JClonable_t, JDerived_t >.

Definition at line 146 of file JMultiMapTransformer.hh.

147 {
148 return new JMultiMapDefaultTransformer(*this);
149 }

◆ putXn()

template<unsigned int N, class JArgument_t >
virtual argument_type JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer::putXn ( const_array_type & buffer,
const argument_type xn ) const
inlineoverridevirtual

Evaluate xn value as a function of {x0, ..., xn-1}.

Parameters
bufferx0 - xn-1 values
xnxn value
Returns
xn value

Implements JTOOLS::JMultiMapTransformer< N, JArgument_t >.

Definition at line 159 of file JMultiMapTransformer.hh.

160 {
161 return xn;
162 }

◆ getXn()

template<unsigned int N, class JArgument_t >
virtual argument_type JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer::getXn ( const_array_type & buffer,
const argument_type xn ) const
inlineoverridevirtual

Evaluate xn value as a function of {x0, ..., xn-1}.

Parameters
bufferx0 - xn-1 values
xnxn value
Returns
xn value

Implements JTOOLS::JMultiMapTransformer< N, JArgument_t >.

Definition at line 172 of file JMultiMapTransformer.hh.

173 {
174 return xn;
175 }

◆ getWeight() [1/2]

template<unsigned int N, class JArgument_t >
virtual double JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer::getWeight ( const_array_type & buffer) const
inlineoverridevirtual

Weight function.

Parameters
bufferx0 - xn-1 values
Returns
weight

Implements JTOOLS::JMultiMapTransformer< N, JArgument_t >.

Definition at line 184 of file JMultiMapTransformer.hh.

185 {
186 return 1.0;
187 }

◆ read()

template<unsigned int N, class JArgument_t >
virtual JReader & JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer::read ( JReader & in)
inlineoverridevirtual

Read from input.

This method reads nothing.

Parameters
inreader
Returns
reader

Implements JIO::JSerialisable.

Definition at line 198 of file JMultiMapTransformer.hh.

199 {
200 return in;
201 }

◆ write()

template<unsigned int N, class JArgument_t >
virtual JWriter & JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer::write ( JWriter & out) const
inlineoverridevirtual

Write to output.

This method writes nothing.

Parameters
outwriter
Returns
writer

Implements JIO::JSerialisable.

Definition at line 212 of file JMultiMapTransformer.hh.

213 {
214 return out;
215 }

◆ getWeight() [2/2]

template<unsigned int N, class JArgument_t >
template<class ... Args>
double JTOOLS::JMultiMapTransformer< N, JArgument_t >::getWeight ( const argument_type x,
const Args &... args ) const
inlineinherited

Weight function.

Parameters
xfirst abscissa values
argscomma seperated list of remaining abscissa values
Returns
weight

Definition at line 84 of file JMultiMapTransformer.hh.

85 {
86 return getWeight(array_type(x, args...));
87 }
virtual double getWeight(const_array_type &buffer) const =0
Weight function.
JArray< N, argument_type > array_type

◆ getDefaultTransformer()

template<unsigned int N, class JArgument_t >
static const JMultiMapTransformer & JTOOLS::JMultiMapTransformer< N, JArgument_t >::getDefaultTransformer ( )
inlinestaticinherited

Get default transformer.

Returns
default transformer

Definition at line 101 of file JMultiMapTransformer.hh.

102 {
103 static const JMultiMapDefaultTransformer transformer;
104
105 return transformer;
106 }

◆ getClone()

template<unsigned int N, class JArgument_t >
static JMultiMapTransformer * JTOOLS::JMultiMapTransformer< N, JArgument_t >::getClone ( )
inlinestaticinherited

Get clone of default transformer.

Returns
pointer to newly created transformer

Definition at line 114 of file JMultiMapTransformer.hh.

115 {
116 return new JMultiMapDefaultTransformer();
117 }

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