#include <GIDI.hpp>

Inheritance diagram for GIDI::Functions::Xs_pdf_cdf1d:

Public Member Functions
	Xs_pdf_cdf1d ()
	Xs_pdf_cdf1d (Axes const &a_axes, ptwXY_interpolation a_interpolation, std::vector< double > const &a_Xs, std::vector< double > const &a_pdf, std::vector< double > const &a_cdf, int a_index=0, double a_outerDomainValue=0.0)
	Xs_pdf_cdf1d (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, Suite *a_parent)
	~Xs_pdf_cdf1d ()
Xs_pdf_cdf1d &	operator= (Xs_pdf_cdf1d const &a_rhs)
double	domainMin () const
double	domainMax () const
std::vector< double > const &	Xs () const
std::vector< double > const &	pdf () const
std::vector< double > const &	cdf () const
double	evaluate (double a_x1) const
XYs1d *	asXYs1d (bool a_asLinlin, double a_accuray, double a_lowerEps, double a_upperEps) const
void	toXMLList_func (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent, bool a_embedded, bool a_inRegions) const
Public Member Functions inherited from GIDI::Functions::Function1dForm
	Function1dForm (std::string const &a_moniker, FormType a_type, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	Function1dForm (std::string const &a_moniker, FormType a_type, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	Function1dForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Function1dForm (Function1dForm const &a_form)
	~Function1dForm ()
Function1dForm &	operator= (Function1dForm const &a_rhs)
virtual void	mapToXsAndAdd (std::size_t a_offset, std::vector< double > const &a_Xs, std::vector< double > &a_results, double a_scaleFactor) const
virtual void	write (FILE *a_file, std::string const &a_format) const
void	print (std::string const &a_format) const
Public Member Functions inherited from GIDI::Functions::FunctionForm
	FunctionForm (std::string const &a_moniker, FormType a_type, int a_dimension, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	FunctionForm (std::string const &a_moniker, FormType a_type, int a_dimension, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
	FunctionForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, int a_dimension, Suite *a_suite=nullptr)
	FunctionForm (FunctionForm const &a_form)
	~FunctionForm ()
FunctionForm &	operator= (FunctionForm const &a_rhs)
int	dimension () const
int	index () const
double	outerDomainValue () const
void	setOuterDomainValue (double a_outerDomainValue)
Axes const &	axes () const
Axes &	axes ()
ptwXY_interpolation	interpolation () const
void	setInterpolation (ptwXY_interpolation a_interpolation)
std::string	interpolationString () const
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent) const
Public Member Functions inherited from GIDI::Form
	Form (FormType a_type)
	Form (std::string const &a_moniker, FormType a_type, std::string const &a_label)
	Form (HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Form (Form const &a_form)
virtual	~Form ()
Form &	operator= (Form const &a_rhs)
Suite *	parent () const
std::string const &	label () const
void	setLabel (std::string const &a_label)
virtual std::string	actualMoniker () const
std::string const &	keyName () const
void	setKeyName (std::string const &a_keyName)
std::string const &	keyValue () const
virtual void	setKeyValue (std::string const &a_keyName) const
FormType	type () const
Form const *	sibling (std::string a_label) const
GUPI::Ancestry *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item)
GUPI::Ancestry const *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
std::string	xlinkItemKey () const
Public Member Functions inherited from GUPI::Ancestry
	Ancestry (std::string const &a_moniker, std::string const &a_attribute="")
virtual	~Ancestry ()
Ancestry &	operator= (Ancestry const &a_ancestry)
std::string const &	moniker () const
void	setMoniker (std::string const &a_moniker)
Ancestry *	ancestor ()
Ancestry const *	ancestor () const
void	setAncestor (Ancestry *a_ancestor)
std::string	attribute () const
Ancestry *	root ()
Ancestry const *	root () const
bool	isChild (Ancestry *a_instance)
bool	isParent (Ancestry *a_parent)
bool	isRoot () const
Ancestry *	findInAncestry (std::string const &a_href)
Ancestry const *	findInAncestry (std::string const &a_href) const
virtual Ancestry *	findInAncestry3 (std::string const &a_item)=0
virtual Ancestry const *	findInAncestry3 (std::string const &a_item) const =0
virtual LUPI_HOST void	serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
std::string	toXLink () const
void	printXML () const

Additional Inherited Members
Static Public Member Functions inherited from GUPI::Ancestry
static std::string	buildXLinkItemKey (std::string const &a_name, std::string const &a_key)

Detailed Description

Class for the GNDS <xs_pdf_cdf1d> node.

Definition at line 1292 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ Xs_pdf_cdf1d() [1/3]

GIDI::Functions::Xs_pdf_cdf1d::Xs_pdf_cdf1d ( )

Definition at line 28 of file GIDI_xs_pdf_cdf1d.cc.

                            :
        Function1dForm( GIDI_xs_pdf_cdf1dChars, FormType::XYs1d, Axes(), ptwXY_interpolationLinLin, 0, 0.0 ) {
 
}

Referenced by operator=().

◆ Xs_pdf_cdf1d() [2/3]

GIDI::Functions::Xs_pdf_cdf1d::Xs_pdf_cdf1d	(	Axes const &	a_axes,
		ptwXY_interpolation	a_interpolation,
		std::vector< double > const &	a_Xs,
		std::vector< double > const &	a_pdf,
		std::vector< double > const &	a_cdf,
		int	a_index = 0,
		double	a_outerDomainValue = 0.0 )

Parameters

a_axes	[in] The axes to copy for this.
a_interpolation	[in] The interpolation flag.
a_index	[in] If imbedded in a two dimensional function, the index of this instance.
a_outerDomainValue	[in] If imbedded in a two dimensional function, the domain value for x2.
a_Xs	[in] List of x1 values.
a_pdf	[in] The pdf evaluated at the x1 values.
a_cdf	[in] The pdf evaluated at the x1 values.

Definition at line 44 of file GIDI_xs_pdf_cdf1d.cc.

                                                                                                                         :
        Function1dForm( GIDI_xs_pdf_cdf1dChars, FormType::xs_pdf_cdf1d, a_axes, a_interpolation, a_index, a_outerDomainValue ),
        m_xs( a_Xs ),
        m_pdf( a_pdf ),
        m_cdf( a_cdf ) {
 
}

◆ Xs_pdf_cdf1d() [3/3]

GIDI::Functions::Xs_pdf_cdf1d::Xs_pdf_cdf1d	(	Construction::Settings const &	a_construction,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		Suite *	a_parent )

Parameters

a_construction	[in] Used to pass user options to the constructor.
a_node	[in] The HAPI::Node to be parsed and used to construct the XYs2d.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_parent	[in] The parent GIDI::Suite.

Definition at line 61 of file GIDI_xs_pdf_cdf1d.cc.

                                                                                                                                        :
        Function1dForm( a_construction, a_node, a_setupInfo, FormType::xs_pdf_cdf1d, a_parent ) {
 
        nf_Buffer<double> buffer;
        parseValuesOfDoubles( a_construction, a_node.child( GIDI_xsChars ).child( GIDI_valuesChars ), a_setupInfo, buffer );
        m_xs = buffer.vector();
        parseValuesOfDoubles( a_construction, a_node.child( GIDI_pdfChars ).child( GIDI_valuesChars ), a_setupInfo, buffer );
        m_pdf = buffer.vector();
        parseValuesOfDoubles( a_construction, a_node.child( GIDI_cdfChars ).child( GIDI_valuesChars ), a_setupInfo, buffer );
        m_cdf = buffer.vector();
}

◆ ~Xs_pdf_cdf1d()

GIDI::Functions::Xs_pdf_cdf1d::~Xs_pdf_cdf1d ( )

Definition at line 76 of file GIDI_xs_pdf_cdf1d.cc.

                             {
 
}

Member Function Documentation

◆ asXYs1d()

XYs1d * GIDI::Functions::Xs_pdf_cdf1d::asXYs1d	(	bool	a_asLinlin,
		double	a_accuray,
		double	a_lowerEps,
		double	a_upperEps ) const

virtual

This methods returns an XYs1d representation of the pdf of this. The calling function owns the created instance and is responible for freeing it.

Parameters

a_asLinlin	[in] This argument is not used but retained to make the methods API at same as other asXYs1d functions.
a_accuracy	[in] This argument is not used but retained to make the methods API at same as other asXYs1d functions.
a_lowerEps	[in] This argument is not used but retained to make the methods API at same as other asXYs1d functions.
a_upperEps	[in] This argument is not used but retained to make the methods API at same as other asXYs1d functions.

Returns: A pointer to an XYs1d instance that must be freed by the calling function.

Reimplemented from GIDI::Functions::Function1dForm.

Definition at line 124 of file GIDI_xs_pdf_cdf1d.cc.

                                                                                                                                                                                 {
 
    return( new XYs1d( axes( ), ptwXY_interpolationLinLin, m_xs, m_pdf ) );
}

Referenced by evaluate().

◆ cdf()

std::vector< double > const & GIDI::Functions::Xs_pdf_cdf1d::cdf ( ) const

inline

Returns the value of the m_cdf member.

Definition at line 1313 of file GIDI.hpp.

Referenced by operator=().

◆ domainMax()

double GIDI::Functions::Xs_pdf_cdf1d::domainMax ( ) const

inlinevirtual

Returns the value of the domainMax.

Implements GIDI::Functions::FunctionForm.

Definition at line 1309 of file GIDI.hpp.

◆ domainMin()

double GIDI::Functions::Xs_pdf_cdf1d::domainMin ( ) const

inlinevirtual

Returns the value of the domainMin.

Implements GIDI::Functions::FunctionForm.

Definition at line 1308 of file GIDI.hpp.

◆ evaluate()

double GIDI::Functions::Xs_pdf_cdf1d::evaluate ( double a_x1 ) const

virtual

Implements GIDI::Functions::Function1dForm.

◆ operator=()

Xs_pdf_cdf1d & GIDI::Functions::Xs_pdf_cdf1d::operator= ( Xs_pdf_cdf1d const & a_rhs )

The assignment operator. This method sets the members of this to those of a_rhs except for those not set by base classes.

Parameters

a_rhs [in] Instance whose member are used to set the members of this.

Definition at line 87 of file GIDI_xs_pdf_cdf1d.cc.

                                                               {
 
    if( this != &a_rhs ) {
        Function1dForm::operator=( a_rhs );
        m_xs = a_rhs.Xs( );
        m_pdf = a_rhs.pdf( );
        m_cdf = a_rhs.cdf( );
    }
 
    return( *this );
}

◆ pdf()

std::vector< double > const & GIDI::Functions::Xs_pdf_cdf1d::pdf ( ) const

inline

Returns the value of the m_pdf member.

Definition at line 1312 of file GIDI.hpp.

Referenced by operator=().

◆ toXMLList_func()

void GIDI::Functions::Xs_pdf_cdf1d::toXMLList_func	(	GUPI::WriteInfo &	a_writeInfo,
		std::string const &	a_indent,
		bool	a_embedded,
		bool	a_inRegions ) const

virtual

Fills the argument a_writeInfo with the XML lines that represent this. Recursively enters each sub-node.

Parameters

a_writeInfo	[in/out] Instance containing incremental indentation and other information and stores the appended lines.
a_indent	[in] The amount to indent this node.
a_embedded	[in] If true, this function is embedded in a higher dimensional function.
a_inRegions	[in] If true, this is in a Regions1d container.

Reimplemented from GIDI::Functions::FunctionForm.

Definition at line 138 of file GIDI_xs_pdf_cdf1d.cc.

                                                                                                                                  {
 
    std::string attributes;
 
    if( a_embedded ) {
        attributes += a_writeInfo.addAttribute( GIDI_outerDomainValueChars, LUPI::Misc::doubleToShortestString( outerDomainValue( ) ) ); }
    else {
        if( a_inRegions ) {
            attributes = a_writeInfo.addAttribute( GIDI_indexChars, intToString( index( ) ) ); }
        else {
            if( label( ) != "" ) attributes = a_writeInfo.addAttribute( GIDI_labelChars, label( ) );
        }
    }
 
    if( interpolation( ) != ptwXY_interpolationLinLin ) attributes += a_writeInfo.addAttribute( GIDI_interpolationChars, interpolationString( ) );
 
    std::string xml = a_writeInfo.nodeStarter( a_indent, moniker( ), attributes );
    xml += nodeWithValuesToDoubles( a_writeInfo,  GIDI_xsChars, m_xs );
    xml += nodeWithValuesToDoubles( a_writeInfo, GIDI_pdfChars, m_pdf );
    xml += nodeWithValuesToDoubles( a_writeInfo, GIDI_cdfChars, m_cdf );
    xml += a_writeInfo.nodeEnder( moniker( ) );
 
    a_writeInfo.push_back( xml );
}

Referenced by evaluate().

◆ Xs()

std::vector< double > const & GIDI::Functions::Xs_pdf_cdf1d::Xs ( ) const

inline

Returns the value of the m_xs member.

Definition at line 1311 of file GIDI.hpp.

Referenced by operator=().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Xs_pdf_cdf1d() [1/3]

◆ Xs_pdf_cdf1d() [2/3]

◆ Xs_pdf_cdf1d() [3/3]

◆ ~Xs_pdf_cdf1d()

Member Function Documentation

◆ asXYs1d()

◆ cdf()

◆ domainMax()

◆ domainMin()

◆ evaluate()

◆ operator=()

◆ pdf()

◆ toXMLList_func()

◆ Xs()