The DataFrameToArray2D class allow to export the data of some TYPE stored in a DataFrame to be exported in an Array2D. More...

#include <STK_DataFrameToArray2D.h>

Public Member Functions
	DataFrameToArray2D (DataFrame const &df)
	Constructor.

	~DataFrameToArray2D ()
	destructor

void	run ()
	run the export.

Array2D< Type > *	p_data ()
	Accessor.

void	release ()
	release the Array2D.

void	eraseNAValues (bool byRow)
	remove NA values from the Array2D

Private Attributes
DataFrame const &	df_
	A reference to the DataFrame we want to exprt.

Array2D< Type > *	p_data_
	A pointer on the 2D Container the class will create.

Detailed Description

template<class Type>
class STK::DataFrameToArray2D< Type >

The DataFrameToArray2D class allow to export the data of some TYPE stored in a DataFrame to be exported in an Array2D.

The 2D container is created on the stack and will be deleted with the DataFrameToArray2D structure. It is possible to release the 2D container by calling explicitly the release(). In this case the end user will have to free directly the Array2D.

Definition at line 55 of file STK_DataFrameToArray2D.h.

Constructor & Destructor Documentation

◆ DataFrameToArray2D()

template<class Type >

STK::DataFrameToArray2D< Type >::DataFrameToArray2D ( DataFrame const & df )

inline

Constructor.

Parameters

df	the DataFrame to export

Definition at line 61 of file STK_DataFrameToArray2D.h.

61: df_(df), p_data_(0) {}

STK::DataFrameToArray2D::p_data_

Array2D< Type > * p_data_

A pointer on the 2D Container the class will create.

Definition STK_DataFrameToArray2D.h:157

STK::DataFrameToArray2D::df_

DataFrame const & df_

A reference to the DataFrame we want to exprt.

Definition STK_DataFrameToArray2D.h:155

◆ ~DataFrameToArray2D()

template<class Type >

STK::DataFrameToArray2D< Type >::~DataFrameToArray2D ( )

inline

destructor

Definition at line 63 of file STK_DataFrameToArray2D.h.

63{ if (p_data_) delete p_data_;}

References STK::DataFrameToArray2D< Type >::p_data_.

Member Function Documentation

◆ eraseNAValues()

template<class Type >

void STK::DataFrameToArray2D< Type >::eraseNAValues ( bool byRow )

inline

remove NA values from the Array2D

Parameters

byRow true if the user want to delete the rows with NA values, false if the user want to remove the column with NA values.

Definition at line 95 of file STK_DataFrameToArray2D.h.

    {
      // check if there exists data
      if (!p_data_) return;
      // get the first index
      const int firstCol = p_data_->beginCols(), firstRow = p_data_->beginRows();
      // get the last index
      int lastCol = p_data_->lastIdxCols(), lastRow = p_data_->lastIdxRows();
      if (byRow)
      {
        // loop on the rows
        for (int i= firstRow; i <= lastRow; ++i)
        {
          bool asNA = false;
          // loop on the element of the row
          for (int j= firstCol; j <= lastCol; ++j)
          {
            if (Arithmetic<Type>::isNA(p_data_->elt(i,j)))
            {
              asNA = true;
              break;
            }
          }
          // remove current row
          if (asNA)
          {
            p_data_->eraseRows(i);
            i--;
            lastRow--;
          }
        }
      }
      else
      {
        // loop on the column
        for (int j= firstCol; j <= lastCol; ++j)
        {
          bool asNA = false;
          // loop on the element of the column
          for (int i= firstRow; i <= lastRow; ++i)
          {
            if (Arithmetic<Type>::isNA(p_data_->elt(i,j)))
            {
              asNA = true;
              break;
            }
          }
          // remove current column
          if (asNA)
          {
            p_data_->eraseCols(j);
            j--;
            lastCol--;
          }
        }
      }
    }

References STK::DataFrameToArray2D< Type >::p_data_.

◆ p_data()

template<class Type >

Array2D< Type > * STK::DataFrameToArray2D< Type >::p_data ( )

inline

Accessor.

get the 2D container. This method is not constant in order to the user to modified directly the 2D container.

Returns: a ptr on the 2D container constructed

Definition at line 88 of file STK_DataFrameToArray2D.h.

88{ return p_data_;}

References STK::DataFrameToArray2D< Type >::p_data_.

◆ release()

template<class Type >

void STK::DataFrameToArray2D< Type >::release ( )

inline

release the Array2D.

It will be freed by the user.

Definition at line 90 of file STK_DataFrameToArray2D.h.

90{ p_data_ =0;}

References STK::DataFrameToArray2D< Type >::p_data_.

◆ run()

template<class Type >

void STK::DataFrameToArray2D< Type >::run ( )

inline

run the export.

Definition at line 65 of file STK_DataFrameToArray2D.h.

    {
      p_data_ = new Array2D<Type>();
      // for each field Try a type conversion
      for(int iVar = df_.beginCols(); iVar<=df_.lastIdxCols(); iVar++)
      {
        IVariable* const p_var = df_.elt(iVar);
        // if there is a variable
        if (p_var)
        {
          // check the type of the variable
          if (p_var->getType() == IdTypeImpl<Type>::returnType())
          {
            Variable<Type>* p_variable = static_cast<Variable<Type>* >(p_var);
            p_data_->pushBackCols(*p_variable);
          }
        }
      }
    }