GIDI::FlattenedArrayData Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::FlattenedArrayData:

Public Member Functions
	FlattenedArrayData (HAPI::Node const &a_node, SetupInfo &a_setupInfo, int a_dimensions, int a_useSystem_strtod)
	~FlattenedArrayData ()
std::vector< std::size_t > const &	shape () const
void	setToValueInFlatRange (std::size_t a_start, std::size_t a_end, double a_value)
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

Public Attributes
std::vector< std::size_t >	m_shape
std::size_t	m_numberOfStarts
std::size_t	m_numberOfLengths
nf_Buffer< int >	m_starts
nf_Buffer< int >	m_lengths
nf_Buffer< double >	m_dValues

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

Definition at line 942 of file GIDI.hpp.

Constructor & Destructor Documentation

FlattenedArrayData()

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

Function to parse a flattened array of dimension a_dimensions.

Parameters

a_node	[in] The HAPI::Node to be parsed.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_dimensions	[in] The dimension of the flattened array to be parsed.
a_useSystem_strtod	[in] Flag passed to the function nfu_stringToListOfDoubles.

Definition at line 237 of file GIDI_arrays.cc.

                                                                                                                                 :
        Form( a_node, a_setupInfo, FormType::flattenedArrayData ),
        m_numberOfStarts( 0 ), 
        m_numberOfLengths( 0 ),
        m_starts( ),
        m_lengths( ) {
 
    bool m_dValuesPresent( false );
 
    std::string shape( a_node.attribute_as_string( GIDI_shapeChars ) );
    auto shapeItems = LUPI::Misc::splitString( shape, ',', true );
    for( auto iter = shapeItems.begin( ); iter != shapeItems.end( ); ++iter ) {
        m_shape.push_back( static_cast<std::size_t>( atoi( (*iter).c_str( ) ) ) );
    }
 
    if( a_dimensions != (int) m_shape.size( ) ) throw Exception( "a_dimensions != m_shape.size( )" );
 
    for( HAPI::Node child = a_node.first_child( ); !child.empty( ); child.to_next_sibling( ) ) {
        std::string name( child.name( ) );
 
        if( name == GIDI_valuesChars ) {
            std::string label( child.attribute_as_string( GIDI_labelChars ) );
            if( label == GIDI_startsChars ) {
                parseValuesOfInts( child, a_setupInfo, m_starts );
                m_numberOfStarts = (std::size_t) m_starts.size(); }
            else if( label == GIDI_lengthsChars ) {
              parseValuesOfInts( child, a_setupInfo, m_lengths );
              m_numberOfLengths = (std::size_t) m_lengths.size(); }
            else if( label == "" ) {
                m_dValuesPresent = true;
                parseValuesOfDoubles( child, a_setupInfo, m_dValues, a_useSystem_strtod ); }
            else {
                throw Exception( "unknown label for flatteded array sub-element" );
            } }
        else {
            throw Exception( "unknown flattened array sub-element" );
        }
    }
    if( m_starts.data() == nullptr ) throw Exception( "array missing starts element" );
    if( m_lengths.data() == nullptr ) throw Exception( "array missing lengths element" );
    if( !m_dValuesPresent ) throw Exception( "array missing dValues element" );
    if( m_numberOfStarts != m_numberOfLengths ) throw Exception( "m_numberOfStarts != m_numberOfLengths for array" );
}

~FlattenedArrayData()

GIDI::FlattenedArrayData::~FlattenedArrayData

(

)

Definition at line 284 of file GIDI_arrays.cc.

                                         {
 
//    smr_freeMemory2( m_starts );
//    smr_freeMemory2( m_lengths );
}

Member Function Documentation

setToValueInFlatRange()

void GIDI::FlattenedArrayData::setToValueInFlatRange	(	std::size_t	a_start,
		std::size_t	a_end,
		double	a_value )

Sets all elements in the range [a_start,a_end) to a_value.

Parameters

a_start	[in] The starting flat-cell index of this to fill with a_value.
a_end	[in] One after the last flat-cell index of this to fill with a_value.
a_value	[in] The value to set each double in the range to.

Definition at line 298 of file GIDI_arrays.cc.

                                                                                                                                     {
 
    std::size_t size = 1;
    for( auto iter = m_shape.begin( ); iter != m_shape.end( ); ++iter ) size *= *iter;
    a_end = std::min( a_end, size );
 
    long numberOfValuesToSet = 0;
    for( std::size_t startIndex = 0; startIndex < m_numberOfStarts; ++startIndex ) {
        std::size_t start = static_cast<std::size_t>( m_starts[startIndex] );
        std::size_t length = static_cast<std::size_t>( m_lengths[startIndex] );
 
        if( ( start + length ) > a_end ) {
            if( a_end < start ) break;
            length = a_end - start;
        }
        numberOfValuesToSet += length;
    }
 
    for( long index = 0; index < numberOfValuesToSet; ++index ) m_dValues[index] = 0.0;
}

shape()

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

inline

Definition at line 955 of file GIDI.hpp.

{ return( m_shape ); }

Referenced by FlattenedArrayData().

toXMLList()

void GIDI::FlattenedArrayData::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.

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 326 of file GIDI_arrays.cc.

                                                                                                {
 
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
    std::vector<int> ints;
 
    std::string shapeString;
    std::string sep = "";
    for( std::size_t i1 = 0; i1 < m_shape.size( ); ++i1 ) {
        shapeString += sep + intToString( static_cast<int>( m_shape[i1] ) );
        sep = ",";
    }
 
    std::string attributes = a_writeInfo.addAttribute( GIDI_shapeChars, shapeString ) + a_writeInfo.addAttribute( "compression", "flattened" );
 
    a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
 
    for( std::size_t i1 = 0; i1 < m_numberOfStarts; ++i1 ) ints.push_back( m_starts[i1] );
    intsToXMLList( a_writeInfo, indent2, ints, " valueType=\"Integer32\" label=\"starts\"" );
 
    ints.clear( );
    for( std::size_t i1 = 0; i1 < m_numberOfLengths; ++i1 ) ints.push_back( m_lengths[i1] );
    intsToXMLList( a_writeInfo, indent2, ints, " valueType=\"Integer32\" label=\"lengths\"" );
 
    doublesToXMLList( a_writeInfo, indent2, m_dValues.vector() );
    a_writeInfo.addNodeEnder( moniker( ) );
}

Member Data Documentation

m_dValues

nf_Buffer<double> GIDI::FlattenedArrayData::m_dValues

The given array data.

Definition at line 950 of file GIDI.hpp.

Referenced by FlattenedArrayData(), GIDI::parseFlattened1d(), setToValueInFlatRange(), and toXMLList().

m_lengths

nf_Buffer<int> GIDI::FlattenedArrayData::m_lengths

The length values.

Definition at line 949 of file GIDI.hpp.

Referenced by FlattenedArrayData(), GIDI::parseFlattened1d(), setToValueInFlatRange(), and toXMLList().

m_numberOfLengths

std::size_t GIDI::FlattenedArrayData::m_numberOfLengths

The number of length values.

Definition at line 947 of file GIDI.hpp.

Referenced by FlattenedArrayData(), and toXMLList().

m_numberOfStarts

std::size_t GIDI::FlattenedArrayData::m_numberOfStarts

The number of start values.

Definition at line 946 of file GIDI.hpp.

Referenced by FlattenedArrayData(), GIDI::parseFlattened1d(), setToValueInFlatRange(), and toXMLList().

m_shape

std::vector<std::size_t> GIDI::FlattenedArrayData::m_shape

The shape of the flattened array.

Definition at line 945 of file GIDI.hpp.

Referenced by FlattenedArrayData(), GIDI::parseFlattened1d(), setToValueInFlatRange(), shape(), and toXMLList().

m_starts

nf_Buffer<int> GIDI::FlattenedArrayData::m_starts

The start values.

Definition at line 948 of file GIDI.hpp.

Referenced by FlattenedArrayData(), GIDI::parseFlattened1d(), setToValueInFlatRange(), and toXMLList().

---

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

• GIDI.hpp
• GIDI_arrays.cc