#include <GIDI.hpp>

Inheritance diagram for GIDI::Array::Array:

Public Member Functions
	Array (HAPI::Node const &a_node, SetupInfo &a_setupInfo, int a_useSystem_strtod)
	~Array ()
std::size_t	dimension () const
std::size_t	size () const
std::vector< std::size_t > const &	shape () const
FullArray	constructArray () 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

The class for storing any GNDS array.

Definition at line 909 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ Array()

GIDI::Array::Array::Array	(	HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		int	a_useSystem_strtod )

Parameters

a_node	[in] The HAPI::Node to be parsed and used to construct the Array2d.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_useSystem_strtod	[in] Flag passed to the function nfu_stringToListOfDoubles.

Definition at line 90 of file GIDI_arrays.cc.

                                                                                     :
        Form( a_node, a_setupInfo, FormType::array ),
        m_shape( parseArrayShape( a_node ) ),
        m_compression( a_node.attribute_as_string( GIDI_compressionChars ) ),
        m_symmetry( a_node.attribute_as_string( GIDI_symmetryChars ) ),
        m_permutation( a_node.attribute_as_string( GIDI_permutationChars ) ),
        m_storageOrder( a_node.attribute_as_string( GIDI_storageOrderChars ) ) {
 
    if( m_compression == "" ) m_compression = GIDI_noneChars;
 
    if( ( m_compression == GIDI_noneChars ) || ( m_compression == GIDI_diagonalChars ) || ( m_compression == GIDI_flattenedChars ) ) {
        for( HAPI::Node child = a_node.first_child( ); !child.empty( ); child.to_next_sibling( ) ) {
            std::string name( child.name( ) );
            if( name != GIDI_valuesChars ) throw Exception( "For '" + moniker( ) + "' array, child node not 'values' but '" + name + "'." );
 
            std::string label1( child.attribute_as_string( GIDI_labelChars ) );
            if( label1 == "" ) {
                parseValuesOfDoubles( child, a_setupInfo, m_values, a_useSystem_strtod ); }
            else if( label1 == GIDI_startingIndices ) {
                if( m_compression != GIDI_diagonalChars ) throw Exception( "Invalid values' label '" + label1 + "'." );
                parseValuesOfInts( child, a_setupInfo, m_starts ); }
            else if( label1 == GIDI_startsChars ) {
                if( m_compression != GIDI_flattenedChars ) throw Exception( "Invalid values' label " + label1 + "." );
                parseValuesOfInts( child, a_setupInfo, m_starts ); }
            else if( label1 == GIDI_lengthsChars ) {
                if( m_compression != GIDI_flattenedChars ) throw Exception( "Invalid values' label '" + label1 + "'." );
                parseValuesOfInts( child, a_setupInfo, m_length ); }
            else {
                throw Exception( "Invalid values' label '" + label1 + "'." );
            }
        } }
    else {                                              // m_compression == GIDI_embeddedChars
        for( HAPI::Node child = a_node.first_child( ); !child.empty( ); child.to_next_sibling( ) ) {
            std::string name( child.name( ) );
            if( name != GIDI_arrayChars ) throw Exception( "For 'embedded' array, child node not 'array' but '" + name + "'." );
 
            m_array.push_back( new Array( child, a_setupInfo, a_useSystem_strtod ) );
        }
    }
}

Referenced by Array().

◆ ~Array()

GIDI::Array::Array::~Array ( )

Definition at line 134 of file GIDI_arrays.cc.

               {
 
    for( auto iter = m_array.begin( ); iter != m_array.end( ); ++iter ) delete *iter;
}

Member Function Documentation

◆ constructArray()

FullArray GIDI::Array::Array::constructArray ( ) const

Returns an array that is a FullArray instance of this. Note, this does not currently handle symmetry, permutation or storageOrder.

Returns: Return a FullArray of this.

Definition at line 160 of file GIDI_arrays.cc.

                                       {
 
    std::vector<double> values( size( ) );
 
    if( m_compression == GIDI_noneChars ) {
        values = m_values.vector( ); }
    else if( m_compression == GIDI_diagonalChars ) {
        throw Exception( "Array::constructArray: compression '" + m_compression + "' not supported." ); }
    else if( m_compression == GIDI_flattenedChars ) {
        std::size_t index = 0;
        for( std::size_t index1 = 0; index1 < m_starts.size( ); ++index1 ) {
            std::size_t length = static_cast<std::size_t>( m_length[index1] );
            std::size_t start = static_cast<std::size_t>( m_starts[index1] );
 
            for( std::size_t index2 = 0; index2 < length; ++index2, ++index ) values[start+index2] = m_values[index];
        } }
    else {
        throw Exception( "Array::constructArray: compression '" + m_compression + "' not supported." );
    }
 
    FullArray fullArray( m_shape, values );
    return( fullArray );
}

◆ dimension()

std::size_t GIDI::Array::Array::dimension ( ) const

inline

Returns the dimension of the array.

Definition at line 927 of file GIDI.hpp.

◆ shape()

std::vector< std::size_t > const & GIDI::Array::Array::shape ( ) const

inline

Returns a const reference to member m_shape.

Definition at line 929 of file GIDI.hpp.

◆ size()

std::size_t GIDI::Array::Array::size ( ) const

Calculates the size of this which is the product of all the m_shape values.

Returns: The product of the m_shape values.

Definition at line 145 of file GIDI_arrays.cc.

                             {
 
    std::size_t size1 = 1;
    for( auto iter = m_shape.begin( ); iter != m_shape.end( ); ++iter ) size1 *= *iter;
 
    return( size1 );
}

Referenced by constructArray().

◆ toXMLList()

void GIDI::Array::Array::toXMLList	(	GUPI::WriteInfo &	a_writeInfo,
		std::string const &	a_indent ) const

virtual

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

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.

Reimplemented from GUPI::Ancestry.

Definition at line 192 of file GIDI_arrays.cc.

                                                                                                                     {
 
}

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

Public Member Functions

Additional Inherited Members