STK::DataFrame Class Reference

DataFrame is a List of Variable with the same number of rows. More...

#include <STK_DataFrame.h>

Inheritance diagram for STK::DataFrame:

Public Types
typedef IContainer2D< UnknownSize, UnknownSize >	Base2D
	Type of the Base container.
typedef List1D< IVariable * >	Base
	Type for the list container.
typedef TRange< UnknownSize >	RowRange
	Type of the Range for the rows.
typedef TRange< UnknownSize >	ColRange
	Type of the Range for the columns.
Public Types inherited from STK::IContainer2D< UnknownSize, UnknownSize >
typedef TRange< SizeRows_ >	RowRange
	Type of the Range for the rows.
typedef TRange< SizeCols_ >	ColRange
	Type of the Range for the columns.

Public Member Functions
	DataFrame ()
	Default Constructor, empty table.
	DataFrame (DataFrame const &T, bool ref=false)
	Copy constructor If ref is true, only references of the variables are copied into the DataFrame.
virtual	~DataFrame ()
	Destructor.
RowRange const &	rows () const
int	beginRows () const
int	endRows () const
int	sizeRows () const
ColRange	cols () const
int	beginCols () const
int	endCols () const
int	sizeCols () const
int	lastIdxRows () const
int	lastIdxCols () const
bool	empty () const
void	clear ()
	Clear the object.
IVariable *&	elt (int const &i)
	access to an element.
IVariable *const	elt (int const &i) const
	access to a constant element.
DataFrame &	operator= (DataFrame const &T)
	Operator = : overwrite the DataFrame with T.
void	resize (Range const &I, Range const &J)
	resize the container:
void	shift (int const &cbeg=1)
	New beginning index for the object.
void	shift (int const &rbeg, int const &cbeg)
	New beginning index for the object.
void	popBackCols (int const &n)
	Delete n columns of the container.
void	eraseCols (int pos, int const &n=1)
	Delete n columns at the position of the container.
void	swapCols (int j1, int j2)
	Swapping the j1th column and the j2th column.
void	popBackRows (int const &n)
	Dell last rows of the container.
void	eraseRows (int pos, int const &n=1)
	Delete n rows at the position pos to the container.
void	insertVariable (int pos, IVariable *const &V)
	Insert a Vartiable at the specified position to the container.
void	pushBackVariable (IVariable *const &V)
	Append a DataFrame back.
void	pushFrontVariable (IVariable *const &V)
	Append a DataFrame front.
void	merge (DataFrame const &D)
	merge this DataFrame with D.
void	insertDataFrame (int pos, DataFrame const &D)
	Insert a DataFrame at the specified position to the container.
void	pushBackDataFrame (DataFrame const &D)
	Append a DataFrame back.
void	pushFrontDataFrame (DataFrame const &D)
	Append a DataFrame front.
void	writeDataFrame (ostream &os, int const &left, int const &right) const
	write a DataFrame to the output stream os.
Public Member Functions inherited from STK::IContainer2D< UnknownSize, UnknownSize >
	IContainer2D ()
	Default constructor.
	IContainer2D (RowRange const &I, ColRange const &J)
	Constructor with specified ranges.
	IContainer2D (IContainer2D const &T)
	Copy constructor.
	~IContainer2D ()
	destructor.
ColRange const &	cols () const
int	beginCols () const
int	endCols () const
int	sizeCols () const
RowRange const &	rows () const
int	beginRows () const
int	endRows () const
int	sizeRows () const
int	lastIdxCols () const
int	lastIdxRows () const
bool	empty () const

Protected Member Functions
void	freeMem ()
	function for memory deallocation.
void	freeCols ()
	function for row memory deallocation.
void	pushBackCols (int const &n=1)
	Add columns to the container.
void	insertCols (int pos, int const &n=1)
	Insert columns at the specified position to the container.
void	pushBackRows (int const &n=1)
	Add n rows to the container.
void	insertRows (int pos, int const &n=1)
	Insert n rows at the ith position of the container.
Protected Member Functions inherited from STK::List1D< IVariable * >
	List1D (Cell *const &p_first, Cell *const &p_last, Range const &J)
	constructor by reference, ref_=1.
void	initialize (Range const &I)
	Protected function for initialization.
void	freeMem ()
	Protected function for deallocation.
	List1D ()
	Default constructor : empty List.
	List1D (Range const &I)
	constructor with specified Range.
	List1D (Range const &I, Type const &v)
	Misc constructor, initialization with a constant.
	List1D (List1D< Type > const &T)
	Copy constructor.
	List1D (List1D< Type > const &T, Range const &J, bool ref=true)
	access to many elements.
RowRange const &	rows () const
int	beginRows () const
int	endRows () const
int	sizeRows () const
ColRange	cols () const
int	beginCols () const
int	endCols () const
int	sizeCols () const
int	lastIdxRows () const
int	lastIdxCols () const
	~List1D ()
	destructor.
Cell const *const	p_begin () const
Cell const *const	p_lastIdx () const
Type &	elt1Impl (int pos)
	access to one element.
Type const &	elt1Impl (int pos) const
	access to one element const.
List1D	subImpl (Range const &J) const
	access to many elements.
void	shiftImpl (int const &beg)
	New first index for the object.
void	clear ()
	Clear the object.
void	pushBack (int const &n=1)
	Add n Elts to the container.
void	insert (Range const &I, Type const &v)
	Insert element v in the range I of the List1D.
void	merge (List1D const &other)
	merge this with other.
void	insertElt (int pos, int const &n=1)
	Insert n elts at the position pos of the container.
void	popBack (int const &n=1)
	Delete n last elements of the container.
void	erase (int pos, int const &n=1)
	Delete n elts at the pos index to the container.
void	swap (int const &j1, int const &j2)
	Swapping the j1th column and the j2th column.
List1D &	operator= (const List1D &T)
	operator = : overwrite the List1D with T.
List1D< Type > &	operator= (Type const &v)
	operator= : set the container to a constant value.
List1D< Type > &	resizeImpl (Range const &I)
	Resize the container.
int	begin () const
int	end () const
int	size () const
int	lastIdx () const
Protected Member Functions inherited from STK::ITContainer1D< Derived >
	ITContainer1D ()
	Default constructor.
	ITContainer1D (RowRange const &I)
	constructor with a specified range.
	~ITContainer1D ()
	destructor.
void	exchange (ITContainer1D &T)
	exchange this container with T
void	setRange (RowRange const &I=RowRange())
	Set range of the rows of the container.
void	incRange (int n=1)
	increment the range of the container (can be negative).
void	incFirst (int n=1)
	increment the beginning of the container (can be negative).
void	decFirst (int n=1)
	decrement the beginning of the container.
void	incLast (int n=1)
	increment the end of the container (can be negative).
void	decLast (int n=1)
	decrement the end of the container.
RowRange const &	range () const
int	begin () const
int	end () const
int	size () const
int	lastIdx () const
Iterator	beginIterator ()
Iterator	endIterator ()
ConstIterator	beginConstIterator () const
ConstIterator	endConstIterator () const
ReverseIterator	rbeginIterator ()
ReverseIterator	rendIterator ()
ConstReverseIterator	rbeginConstIterator () const
ConstReverseIterator	rendConstIterator () const
bool	empty () const
	Is there some data ?
Type &	elt (int i)
TypeConst	elt (int i) const
Type &	operator[] (int i)
TypeConst	operator[] (int i) const
Type &	at (int i)
TypeConst	at (int i) const
SubVector	sub (Range const &I) const
	Access to many elements.
Type &	front ()
TypeConst	front () const
Type &	back ()
TypeConst	back () const
void	shift (int beg)
Derived &	resize (Range const &I=RowRange())
Protected Member Functions inherited from STK::IRecursiveTemplate< Derived >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.
Derived &	asDerived ()
	static cast : return a reference of this with a cast to the derived class.
Derived const &	asDerived () const
	static cast : return a const reference of this with a cast to the derived class.
Derived *	asPtrDerived ()
	static cast : return a ptr on a Derived of this with a cast to the derived class.
Derived const *	asPtrDerived () const
	static cast : return a ptr on a constant Derived of this with a cast to the derived class.
Derived *	clone () const
	create a leaf using the copy constructor of the Derived class.
Derived *	clone (bool isRef) const
	create a leaf using the copy constructor of the Derived class and a flag determining if the clone is a reference or not.
Protected Member Functions inherited from STK::TRef<-1 >
	TRef (bool ref)
	Default constructor We have to specify the member ref_.
	~TRef ()
	destructor.
bool	isRef () const
bool	ref () const
void	exchange (TRef const &T)
	swap this with the container T.
void	setRef (bool ref) const
	Modify the container : can become a reference or the owner of the data.
Protected Member Functions inherited from STK::IContainer2D< UnknownSize, UnknownSize >
void	shift (int rbeg, int cbeg)
	Set the first index of the rows and columns.
void	setRanges (RowRange const &I=RowRange(), ColRange const &J=ColRange())
	Set the ranges of the container.
void	setRows (RowRange const &I=RowRange())
	Set the range of the number of rows.
void	shiftRows (int beg)
	Set the first index of the rows.
void	incRangeRows (int inc)
	Increment the range of the number of rows.
void	incBeginRows (int inc)
	Increment the first index of the number of rows.
void	decBeginRows (int dec)
	Decrement the first index of the number of rows.
void	incEndRows (int inc)
	Increment the end of the number of rows.
void	decEndRows (int dec)
	Decrement the end of the number of rows.
void	setCols (ColRange const &J=ColRange())
	Set the columns range.
void	shiftCols (int beg)
	Shift the columns first index to beg.
void	incRangeCols (int inc)
	Increment the columns range.
void	incBeginCols (int inc)
	increment the first index of the columns.
void	decBeginCols (int dec)
	Decrement the columns first index.
void	incEndCols (int inc)
	Increment the last index of the columns.
void	decEndCols (int dec)
	Decrement the last index of the columns.
void	exchange (IContainer2D &T)
	exchange this container with T
void	incLastIdxRows (int inc)
	Increment the end of the number of rows.
void	decLastIdxRows (int dec)
	Decrement the end of the number of rows.
void	incLastIdxCols (int inc)
	Increment the last index of the columns.
void	decLastIdxCols (int dec)
	Decrement the last index of the columns.
	IContainer2D ()
	Default constructor.
	IContainer2D (RowRange const &I, ColRange const &J)
	Constructor with specified ranges.
	IContainer2D (IContainer2D const &T)
	Copy constructor.
	~IContainer2D ()
	destructor.
ColRange const &	cols () const
int	beginCols () const
int	endCols () const
int	sizeCols () const
RowRange const &	rows () const
int	beginRows () const
int	endRows () const
int	sizeRows () const
int	lastIdxCols () const
int	lastIdxRows () const
bool	empty () const

Additional Inherited Members
Protected Types inherited from STK::List1D< IVariable * >
enum
typedef hidden::Traits< List1D< IVariable * > >::Type	Type
typedef hidden::Traits< List1D< IVariable * > >::TypeConst	TypeConst
typedef hidden::Traits< List1D< IVariable * > >::RowRange	RowRange
typedef hidden::Traits< List1D< IVariable * > >::ColRange	ColRange
typedef ITContainer1D< List1D< Type > >	Base
typedef CellHo< Type >	Cell
typedef hidden::Traits< List1D< IVariable * > >::Iterator	Iterator
typedef hidden::Traits< List1D< IVariable * > >::ConstIterator	ConstIterator
typedef hidden::Traits< List1D< IVariable * > >::ReverseIterator	ReverseIterator
typedef hidden::Traits< List1D< IVariable * > >::ConstReverseIterator	ConstReverseIterator
typedef Iterator	iterator
typedef ConstIterator	const_iterator
typedef ReverseIterator	reverse_iterator
typedef ConstReverseIterator	const_reverse_iterator
Protected Types inherited from STK::ITContainer1D< Derived >
enum	{ size_ = hidden::Traits<Derived>::size_ }
typedef hidden::Traits< Derived >::Type	Type
typedef hidden::Traits< Derived >::TypeConst	TypeConst
typedef hidden::Traits< Derived >::RowRange	RowRange
typedef hidden::Traits< Derived >::ColRange	ColRange
typedef hidden::Traits< Derived >::Row	Row
typedef hidden::Traits< Derived >::Col	Col
typedef hidden::Traits< Derived >::SubVector	SubVector
typedef hidden::Traits< Derived >::Iterator	Iterator
typedef hidden::Traits< Derived >::ConstIterator	ConstIterator
typedef hidden::Traits< Derived >::ReverseIterator	ReverseIterator
typedef hidden::Traits< Derived >::ConstReverseIterator	ConstReverseIterator
Protected Types inherited from STK::IContainer2D< UnknownSize, UnknownSize >
typedef TRange< SizeRows_ >	RowRange
	Type of the Range for the rows.
typedef TRange< SizeCols_ >	ColRange
	Type of the Range for the columns.
Protected Attributes inherited from STK::List1D< IVariable * >
Cell *	p_begin_
	First Element of the List.
Cell *	p_last_
	Last Element of the List.

Detailed Description

DataFrame is a List of Variable with the same number of rows.

This is thus also a 2D container.

A DataFrame inherit from the class List1D and and IContainer2D. It is essentially a List, except that each column (the variables) possess the same dimension.

Each Cell of the List1D contain a pointer on a Variable.

Definition at line 58 of file STK_DataFrame.h.

Member Typedef Documentation

Base

typedef List1D<IVariable*> STK::DataFrame::Base

Type for the list container.

Definition at line 64 of file STK_DataFrame.h.

Base2D

typedef IContainer2D<UnknownSize, UnknownSize > STK::DataFrame::Base2D

Type of the Base container.

Definition at line 62 of file STK_DataFrame.h.

ColRange

typedef TRange<UnknownSize> STK::DataFrame::ColRange

Type of the Range for the columns.

Definition at line 68 of file STK_DataFrame.h.

RowRange

typedef TRange<UnknownSize> STK::DataFrame::RowRange

Type of the Range for the rows.

Definition at line 66 of file STK_DataFrame.h.

Constructor & Destructor Documentation

DataFrame() [1/2]

STK::DataFrame::DataFrame

(

)

Default Constructor, empty table.

Definition at line 41 of file STK_DataFrame.cpp.

: Base(), Base2D() {}

DataFrame() [2/2]

STK::DataFrame::DataFrame	(	DataFrame const &	T,
		bool	ref = false
	)

Copy constructor If ref is true, only references of the variables are copied into the DataFrame.

Parameters

T	the DataFrame to copy
ref	true if we want to wrap the variables of T

Definition at line 44 of file STK_DataFrame.cpp.

                   : Base(T.range())
                    , Base2D(T)
{
  // we need to copy explicitly the data
  for (int j=begin(); j<end(); j++) // for all columns
    if (T[j])                            // if there is data
      elt(j) = T[j]->clone(ref); // set the adress of a clone
}

References STK::List1D< IVariable * >::begin(), STK::IRecursiveTemplate< Derived >::clone(), elt(), STK::List1D< IVariable * >::end(), and STK::TRef<-1 >::ref().

~DataFrame()

STK::DataFrame::~DataFrame ( )

virtual

Destructor.

Definition at line 55 of file STK_DataFrame.cpp.

{ if (!isRef()) freeCols();}

References freeCols(), and STK::TRef<-1 >::isRef().

Member Function Documentation

beginCols()

int STK::DataFrame::beginCols ( ) const

inline

Returns

the index of the first column

Definition at line 94 of file STK_DataFrame.h.

{ return  Base2D::beginCols();}

References STK::IContainer2D< UnknownSize, UnknownSize >::beginCols().

Referenced by STK::ExportToCsv::ExportToCsv(), insertDataFrame(), insertVariable(), merge(), STK::operator<<(), pushFrontDataFrame(), pushFrontVariable(), STK::DataFrameToArray2D< Type >::run(), and shift().

beginRows()

int STK::DataFrame::beginRows ( ) const

inline

Returns

the index of the first element

Definition at line 85 of file STK_DataFrame.h.

{ return Base2D::beginRows();}

References STK::IContainer2D< UnknownSize, UnknownSize >::beginRows().

Referenced by eraseRows(), insertDataFrame(), insertRows(), insertVariable(), merge(), pushBackDataFrame(), pushBackVariable(), shift(), and writeDataFrame().

clear()

void STK::DataFrame::clear

(

)

Clear the object.

Definition at line 58 of file STK_DataFrame.cpp.

{
  freeMem();
  // set default range for list
  Base::setRange();
  // set default range for container2D
  Base2D::setRanges(0, 0);
}

References freeMem(), STK::ITContainer1D< Derived >::setRange(), and STK::IContainer2D< UnknownSize, UnknownSize >::setRanges().

cols()

ColRange STK::DataFrame::cols ( ) const

inline

Returns

the Horizontal range (1 column)

Definition at line 92 of file STK_DataFrame.h.

{ return ColRange(1);}

Referenced by operator=(), and resize().

elt() [1/2]

IVariable *& STK::DataFrame::elt ( int const &  i )

inline

access to an element.

Set the method elt as a public method.

Definition at line 112 of file STK_DataFrame.h.

{ return Base::elt(i);}

References STK::ITContainer1D< Derived >::elt().

Referenced by DataFrame(), eraseCols(), eraseRows(), STK::ExportToCsv::ExportToCsv(), freeCols(), insertDataFrame(), insertRows(), insertVariable(), merge(), operator=(), popBackCols(), popBackRows(), pushBackDataFrame(), pushBackRows(), pushBackVariable(), STK::DataFrameToArray2D< Type >::run(), and shift().

elt() [2/2]

IVariable *const STK::DataFrame::elt ( int const &  i ) const

inline

access to a constant element.

Set the method elt as a public method.

Definition at line 114 of file STK_DataFrame.h.

{ return Base::elt(i);}

References STK::ITContainer1D< Derived >::elt().

empty()

bool STK::DataFrame::empty ( ) const

inline

Returns

true if the container is empty, false otherwise

Definition at line 107 of file STK_DataFrame.h.

{ return Base::empty();}

References STK::ITContainer1D< Derived >::empty().

Referenced by insertDataFrame(), and pushBackDataFrame().

endCols()

int STK::DataFrame::endCols ( ) const

inline

Returns

the index of the ending column

Definition at line 96 of file STK_DataFrame.h.

{ return  Base2D::endCols();}

References STK::IContainer2D< UnknownSize, UnknownSize >::endCols().

Referenced by STK::ExportToCsv::ExportToCsv().

endRows()

int STK::DataFrame::endRows ( ) const

inline

Returns

the ending index of the elements

Definition at line 87 of file STK_DataFrame.h.

{ return  Base2D::endRows();}

References STK::IContainer2D< UnknownSize, UnknownSize >::endRows().

eraseCols()

void STK::DataFrame::eraseCols	(	int	pos,
		int const &	n = 1
	)

Delete n columns at the position of the container.

Definition at line 178 of file STK_DataFrame.cpp.

{
  // if n<=0 nothing to do
  if (n<=0) return;
  // check conditions
  if (pos<begin())
  { STKOUT_OF_RANGE_2ARG(DataFrame::eraseCols,pos, n,pos<begin());}
  if (pos>lastIdx())
  { STKOUT_OF_RANGE_2ARG(DataFrame::eraseCols,pos, n,pos>lastIdx());}
  if (lastIdx() < pos+n-1)
  { STKOUT_OF_RANGE_2ARG(DataFrame::eraseCols,pos, n,lastIdx()<pos+n-1);}
  // for all columns, delete variables
  for (int j=pos+n-1; j>=pos; j--)
    if (elt(j)) { delete elt(j);}
  // delete elements of the List1D
  erase(pos, n);
  // update cols_
  decLastIdxCols(n);
  // if it was the last col, free mem
  if (this->sizeCols() == 0) freeMem();
}

References STK::List1D< IVariable * >::begin(), STK::IContainer2D< UnknownSize, UnknownSize >::decLastIdxCols(), elt(), STK::List1D< IVariable * >::erase(), eraseCols(), freeMem(), STK::List1D< IVariable * >::lastIdx(), sizeCols(), and STKOUT_OF_RANGE_2ARG.

Referenced by eraseCols().

eraseRows()

void STK::DataFrame::eraseRows	(	int	pos,
		int const &	n = 1
	)

Delete n rows at the position pos to the container.

Parameters

pos	position of the rows to delete
n	number of rows to delete

Definition at line 443 of file STK_DataFrame.cpp.

{
  // if n<=0 nothing to do
  if (n<=0) return;
  if (beginRows() > pos)
  { STKOUT_OF_RANGE_2ARG(DataFrame::eraseRows,pos, n,beginRows() > pos);}
  if (lastIdxRows() < pos)
  { STKOUT_OF_RANGE_2ARG(DataFrame::eraseRows,pos, n,lastIdxRows() < pos);}
  if (lastIdxRows() < pos+n-1)
  { STKOUT_OF_RANGE_2ARG(DataFrame::eraseRows,pos, n,lastIdxRows() < pos+n-1);}
  // for each variable erase elts
  for (int j=begin(); j<=lastIdx(); j++)
    if (elt(j)) { elt(j)->erase(pos, n);}
  // update rows_
  decLastIdxRows(n);
}

References STK::List1D< IVariable * >::begin(), beginRows(), STK::IContainer2D< UnknownSize, UnknownSize >::decLastIdxRows(), elt(), STK::IVariable::erase(), eraseRows(), STK::List1D< IVariable * >::lastIdx(), lastIdxRows(), and STKOUT_OF_RANGE_2ARG.

Referenced by eraseRows().

freeCols()

void STK::DataFrame::freeCols ( )

protected

function for row memory deallocation.

Definition at line 472 of file STK_DataFrame.cpp.

{
  if (isRef()) return;
  // for all columns
  for (int j=begin(); j<=lastIdx(); j++)
    if (elt(j))          // if there is mem allocated
    { delete elt(j); elt(j) = 0;}
  // set default range
  setRows();
}

References STK::List1D< IVariable * >::begin(), elt(), STK::TRef<-1 >::isRef(), STK::List1D< IVariable * >::lastIdx(), and STK::IContainer2D< UnknownSize, UnknownSize >::setRows().

Referenced by freeMem(), and ~DataFrame().

freeMem()

void STK::DataFrame::freeMem ( )

protected

function for memory deallocation.

Definition at line 461 of file STK_DataFrame.cpp.

{
  if (isRef()) return;
  // liberate variables
  freeCols();
  Base::freeMem();
  setRows();
  setCols();
}

References freeCols(), STK::List1D< IVariable * >::freeMem(), STK::TRef<-1 >::isRef(), STK::IContainer2D< UnknownSize, UnknownSize >::setCols(), and STK::IContainer2D< UnknownSize, UnknownSize >::setRows().

Referenced by clear(), eraseCols(), and popBackCols().

insertCols()

void STK::DataFrame::insertCols ( int  pos, int const &  n = 1  )

protected

Insert columns at the specified position to the container.

Definition at line 387 of file STK_DataFrame.cpp.

{
  if (n <= 0) return;        // if n<=0 nothing to do
  // check conditions
  if (pos<begin())
  { STKOUT_OF_RANGE_2ARG(DataFrame::insertCols,pos, n,pos<begin());}
  if (pos>lastIdx())
  { STKOUT_OF_RANGE_2ARG(Dataframe::insertCols,pos, n,pos>lastIdx());}
  // insert n elements in list1D
  insert(Range(pos, n), 0);
  // update IContainer2D
  incLastIdxCols(n);
}

References STK::List1D< IVariable * >::begin(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxCols(), STK::List1D< IVariable * >::insert(), insertCols(), STK::List1D< IVariable * >::lastIdx(), and STKOUT_OF_RANGE_2ARG.

Referenced by insertCols().

insertDataFrame()

void STK::DataFrame::insertDataFrame	(	int	pos,
		DataFrame const &	D
	)

Insert a DataFrame at the specified position to the container.

Definition at line 292 of file STK_DataFrame.cpp.

{
  if (D.empty()) return;
  // is this structure just a pointer?
  if (this->isRef())
  { STKRUNTIME_ERROR_1ARG(DataFrame::insertDataFrame,pos,cannot operate on reference);}
  if (begin()>pos)
  { STKOUT_OF_RANGE_1ARG(DataFrame::insertDataFrame,pos,begin()>pos);}
  if (lastIdx()+1<pos)
  { STKOUT_OF_RANGE_1ARG(DataFrame::insertDataFrame,pos,lastIdx()+1<pos);}
  // List1D
  insertElt(pos, D.sizeCols());
  // insert all columns of D
  for (int i = D.beginCols(), icol = pos; i <=D.lastIdxCols(); i++, icol++)
  {
    if (D.elt(i))
    {
      elt(icol) = D.elt(i)->clone();
      elt(icol)->shift(beginRows());
    }
    else { elt(icol) = 0;}
  }
  // update LastHo
  incLastIdxCols(D.sizeCols());
  // update rows with NA values
  int inc = sizeRows() - D.sizeRows();
  if (inc == 0) return; // same size
  if (inc > 0) // D has less rows
  { // put NA values to the inserted columns
    for (int i= pos+D.sizeCols()-1; i >=pos; i--)
      if (elt(i)) { elt(i)->pushBackNAValues(inc);}
  }
  else
  { // put NA values to the oter columns
    for (int i=this->beginCols(); i <pos; i++)
      if (elt(i)) { elt(i)->pushBackNAValues(-inc);}
    for (int i=pos+D.sizeCols(); i <=this->lastIdx(); i++)
      if (elt(i)) { elt(i)->pushBackNAValues(-inc);}
    // update LastVe
    incLastIdxRows(-inc);
  }
}

References STK::List1D< IVariable * >::begin(), beginCols(), beginRows(), STK::IVariable::clone(), elt(), empty(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxCols(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxRows(), insertDataFrame(), STK::List1D< IVariable * >::insertElt(), STK::TRef<-1 >::isRef(), STK::List1D< IVariable * >::lastIdx(), lastIdxCols(), STK::IVariable::pushBackNAValues(), STK::IVariable::shift(), sizeCols(), sizeRows(), STKOUT_OF_RANGE_1ARG, and STKRUNTIME_ERROR_1ARG.

Referenced by insertDataFrame(), and pushFrontDataFrame().

insertRows()

void STK::DataFrame::insertRows ( int  pos, int const &  n = 1  )

protected

Insert n rows at the ith position of the container.

Definition at line 416 of file STK_DataFrame.cpp.

{
  // if n<=0 nothing to do
  if (n<=0) return;
  if (beginRows() > pos)
  { STKOUT_OF_RANGE_2ARG(DataFrame::insertRows,pos, n,beginRows() > pos);}
  if (lastIdxRows()+1 < pos)
  { STKOUT_OF_RANGE_2ARG(DataFrame::insertRows,pos, n,lastIdxRows()+1 < pos);}
  // insert rows to each variables
  for (int j=begin(); j<=lastIdx(); j++)
    if (elt(j)) { elt(j)->insertElt(pos, n);}
  // update rows_
  incLastIdxRows(n);
}

References STK::List1D< IVariable * >::begin(), beginRows(), elt(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxRows(), STK::IVariable::insertElt(), insertRows(), STK::List1D< IVariable * >::lastIdx(), lastIdxRows(), and STKOUT_OF_RANGE_2ARG.

Referenced by insertRows().

insertVariable()

void STK::DataFrame::insertVariable	(	int	pos,
		IVariable *const &	V
	)

Insert a Vartiable at the specified position to the container.

Parameters

pos	the position in the container
V	the Variable to insert

Definition at line 201 of file STK_DataFrame.cpp.

{
  // List1D
  List1D<IVariable*>::insertElt(pos);
  elt(pos) = V;
  // the variable have to be in the same range
  elt(pos)->shift(beginRows());
  // update horizontal range (the number of column)
  incLastIdxCols(1);
 
  // update rows with NA values
  int inc = sizeRows() - V->size();
  if (inc == 0) return; // same size
  if (inc > 0) // V has less rows
  { // put NA values to the inserted column
    elt(pos)->pushBackNAValues(inc);
  }
  else
  { // put NA values to the other columns
    for (int i=this->beginCols(); i <pos; i++)
      if (elt(i)) { elt(i)->pushBackNAValues(-inc);}
    for (int i=pos+1; i <=this->lastIdxCols(); i++)
      if (elt(i)) { elt(i)->pushBackNAValues(-inc);}
    // update LastVe
    incLastIdxRows(-inc);
  }
}

References beginCols(), beginRows(), elt(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxCols(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxRows(), STK::List1D< Type_ >::insertElt(), lastIdxCols(), STK::IVariable::pushBackNAValues(), STK::IVariable::shift(), STK::IVariable::size(), and sizeRows().

Referenced by pushFrontVariable().

lastIdxCols()

int STK::DataFrame::lastIdxCols ( ) const

inline

Returns

the index of the last element

Definition at line 103 of file STK_DataFrame.h.

{ return baseIdx;}

References STK::baseIdx.

Referenced by insertDataFrame(), insertVariable(), STK::operator<<(), popBackCols(), pushBackVariable(), resize(), and STK::DataFrameToArray2D< Type >::run().

lastIdxRows()

int STK::DataFrame::lastIdxRows ( ) const

inline

Returns

the index of the last element

Definition at line 101 of file STK_DataFrame.h.

{ return this->lastIdx();}

References STK::List1D< IVariable * >::lastIdx().

Referenced by eraseRows(), insertRows(), resize(), and writeDataFrame().

merge()

void STK::DataFrame::merge

(

DataFrame const &

D

)

merge this DataFrame with D.

Definition at line 256 of file STK_DataFrame.cpp.

{
  if (other.empty()) return;
  // is this structure just a pointer?
  if (this->isRef())
  { STKRUNTIME_ERROR_NO_ARG(DataFrame::merge(other),*this is a reference.);}
  // is T just a pointer?
  if (other.isRef())
  { STKRUNTIME_ERROR_NO_ARG(DataFrame::merge(other),other is a reference.);}
  // break const reference
  DataFrame& otherRef = const_cast<DataFrame&>(other);
  // update rows with NA values
  int pos(lastIdx()+1), inc = sizeRows() - otherRef.sizeRows();
 
  otherRef.shift(beginRows(), beginCols());
  Base::merge(otherRef);
 
  if (inc == 0) return; // same size
 
  if (inc > 0) // other has less rows
  { // put NA values to the merged columns
    for (int i= lastIdx(); i >=pos; i--)
      if (elt(i)) { elt(i)->pushBackNAValues(inc);}
  }
  else
  { // put NA values to the existing columns
    for (int i=this->begin(); i <pos; i++)
      if (elt(i)) { elt(i)->pushBackNAValues(-inc);}
 
    // update LastVe
    incLastIdxRows(-inc);
  }
 
}

References STK::List1D< IVariable * >::begin(), beginCols(), beginRows(), elt(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxRows(), STK::TRef<-1 >::isRef(), STK::List1D< IVariable * >::lastIdx(), merge(), STK::List1D< IVariable * >::merge(), STK::IVariable::pushBackNAValues(), sizeRows(), and STKRUNTIME_ERROR_NO_ARG.

Referenced by merge().

operator=()

DataFrame & STK::DataFrame::operator=

(

DataFrame const &

T

)

Operator = : overwrite the DataFrame with T.

Definition at line 68 of file STK_DataFrame.cpp.

{
  // Resize if necessary.
  if (sizeCols() != T.sizeCols()) Base::resize(T.cols());
 
  // Copy without overlapping.
  if ((T.begin()>=begin()))
  {
    for (int jt=T.begin(), j=begin(); jt<=T.lastIdx(); j++, jt++)
    {
      // clear old mem if any
      if (elt(j)) delete elt(j);
      // if there is a variable, create a copy
      if (T[jt]) elt(j) = T[jt]->clone();
      else       elt(j) = 0;
    }
  }
  else
  {
    for (int jt=T.lastIdx(), j=lastIdx(); jt>=T.begin(); j--, jt--)
    {
      // clear old mem if any
      if (elt(j)) delete elt(j);
      // if there is a variable, create a copy
      if (T[jt]) elt(j) = T[jt]->clone();
      else       elt(j) = 0;
    }
  }
  return *this;
}

References STK::List1D< IVariable * >::begin(), STK::List1D< Type_ >::begin(), STK::IRecursiveTemplate< Derived >::clone(), cols(), elt(), STK::List1D< IVariable * >::lastIdx(), STK::List1D< Type_ >::lastIdx(), STK::ITContainer1D< Derived >::resize(), and sizeCols().

popBackCols()

void STK::DataFrame::popBackCols

(

int const &

n

)

Delete n columns of the container.

Definition at line 159 of file STK_DataFrame.cpp.

{
  // if n<=0 nothing to do
  if (n<=0) return;
  // if there is columns to erase
  if (sizeCols()<n)
  { STKOUT_OF_RANGE_1ARG(DataFrame::popBackCols,n,sizeCols()<n);}
  // for all columns, delete variables
  for (int j=lastIdxCols() - n +1; j<=lastIdxCols(); j++)
    if (elt(j)) delete elt(j);
  // popBack() of List1D
  Base::popBack(n);
  // update IContainer2D
  decLastIdxCols(n);
  // if it was the last elt, free mem
  if (this->sizeCols() == 0) freeMem();
}

References STK::IContainer2D< UnknownSize, UnknownSize >::decLastIdxCols(), elt(), freeMem(), lastIdxCols(), STK::List1D< IVariable * >::popBack(), popBackCols(), sizeCols(), and STKOUT_OF_RANGE_1ARG.

Referenced by popBackCols(), and resize().

popBackRows()

void STK::DataFrame::popBackRows

(

int const &

n

)

Dell last rows of the container.

Parameters

n	number of rows to delete

Definition at line 432 of file STK_DataFrame.cpp.

{
  if (sizeRows() < n)
  { STKOUT_OF_RANGE_1ARG(DataFrame::popBackRows,n,sizeRows() < n);}
  // del last row to each variable
  for (int j=begin(); j<=lastIdx(); j++)
    if (elt(j)) { elt(j)->popBack(n);}
  decLastIdxRows(n);
}

References STK::List1D< IVariable * >::begin(), STK::IContainer2D< UnknownSize, UnknownSize >::decLastIdxRows(), elt(), STK::List1D< IVariable * >::lastIdx(), STK::IVariable::popBack(), popBackRows(), sizeRows(), and STKOUT_OF_RANGE_1ARG.

Referenced by popBackRows(), and resize().

pushBackCols()

void STK::DataFrame::pushBackCols ( int const &  n = 1 )

protected

Add columns to the container.

Definition at line 376 of file STK_DataFrame.cpp.

{
  // if n<=0 nothing to do
  if (n <= 0) return;
  // add n columns to list1D
  insert(Range(lastIdx()+1, n), 0);
  // update IContainer2D
  incLastIdxCols(n);
}

References STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxCols(), STK::List1D< IVariable * >::insert(), and STK::List1D< IVariable * >::lastIdx().

Referenced by resize().

pushBackDataFrame()

void STK::DataFrame::pushBackDataFrame

(

DataFrame const &

D

)

Append a DataFrame back.

Definition at line 337 of file STK_DataFrame.cpp.

{
  if (D.empty()) return;
  // is this structure just a pointer?
  if (this->isRef())
  { STKRUNTIME_ERROR_NO_ARG(DataFrame::pushBackDataFrame,cannot operate on reference);}
  // compute pos
  int pos(lastIdx()+1);
  // List1D
  pushBack(D.sizeCols());
  // insert all columns of D
  for (int i = D.begin(), icol = pos; i <=D.lastIdx(); i++, icol++)
  {
    if (D.elt(i))
    {
      elt(icol) = D.elt(i)->clone();
      elt(icol)->shift(beginRows());
    }
  }
  // update LastHo
  incLastIdxCols(D.sizeCols());
  // update rows with NA values
  int inc = sizeRows() - D.sizeRows();
  if (inc == 0) return; // same size
  if (inc > 0) // D has less rows
  { // put NA values to the inserted columns
    for (int i= lastIdx(); i >=pos; i--)
      if (elt(i)) { elt(i)->pushBackNAValues(inc);}
  }
  else
  { // put NA values to the oter columns
    for (int i=this->begin(); i <pos; i++)
      if (elt(i)) { elt(i)->pushBackNAValues(-inc);}
    // update LastVe
    incLastIdxRows(-inc);
  }
}

References STK::List1D< Type_ >::begin(), STK::List1D< IVariable * >::begin(), beginRows(), STK::IVariable::clone(), elt(), empty(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxCols(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxRows(), STK::TRef<-1 >::isRef(), STK::List1D< IVariable * >::lastIdx(), STK::List1D< Type_ >::lastIdx(), STK::List1D< IVariable * >::pushBack(), pushBackDataFrame(), STK::IVariable::pushBackNAValues(), STK::IVariable::shift(), sizeCols(), sizeRows(), and STKRUNTIME_ERROR_NO_ARG.

Referenced by pushBackDataFrame().

pushBackRows()

void STK::DataFrame::pushBackRows ( int const &  n = 1 )

protected

Add n rows to the container.

Definition at line 402 of file STK_DataFrame.cpp.

{
  // if n<=0 nothing to do
  if (n<=0) return;
  // for each column append row
  for (int j=begin(); j<=lastIdx(); j++)
  {
    if (elt(j)) { elt(j)->pushBack(n);}
  }
  // update range of the container
  incRangeRows(n);
}

References STK::List1D< IVariable * >::begin(), elt(), STK::IContainer2D< UnknownSize, UnknownSize >::incRangeRows(), STK::List1D< IVariable * >::lastIdx(), and STK::IVariable::pushBack().

Referenced by resize().

pushBackVariable()

void STK::DataFrame::pushBackVariable

(

IVariable *const &

V

)

Append a DataFrame back.

Parameters

V	The variable to append to the DataFrame

Definition at line 230 of file STK_DataFrame.cpp.

{
  // List1D
  pushBack();
  back() = V;
  // update horizontal range (the number of column)
  incLastIdxCols(1);
  // adjust the first index of the inserted variable
  elt(lastIdxCols())->shift(beginRows());
  // update rows with NA values
  int inc = sizeRows() - V->size();
  if (inc == 0) return; // same size
  if (inc > 0) //V has less rows
  { // put NA values to the inserted columns
    elt(lastIdxCols())->pushBackNAValues(inc);
  }
  else
  { // put NA values to the oter columns
    for (int i=this->begin(); i <lastIdxCols(); i++)
      if (elt(i)) { elt(i)->pushBackNAValues(-inc);}
    // update LastVe
    incLastIdxRows(-inc);
  }
}

References STK::ITContainer1D< Derived >::back(), STK::List1D< IVariable * >::begin(), beginRows(), elt(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxCols(), STK::IContainer2D< UnknownSize, UnknownSize >::incLastIdxRows(), lastIdxCols(), STK::List1D< IVariable * >::pushBack(), STK::IVariable::pushBackNAValues(), STK::IVariable::shift(), STK::IVariable::size(), and sizeRows().

Referenced by STK::ImportFromCsv::asNumeric(), STK::ImportFromCsv::asOnlyNumeric(), and STK::ImportFromCsv::asString().

pushFrontDataFrame()

void STK::DataFrame::pushFrontDataFrame ( DataFrame const &  D )

inline

Append a DataFrame front.

Definition at line 177 of file STK_DataFrame.h.

    { insertDataFrame(beginCols(), D);}

References beginCols(), and insertDataFrame().

pushFrontVariable()

void STK::DataFrame::pushFrontVariable ( IVariable *const &  V )

inline

Append a DataFrame front.

Definition at line 168 of file STK_DataFrame.h.

    { insertVariable(beginCols(), V);}

References beginCols(), and insertVariable().

resize()

void STK::DataFrame::resize	(	Range const &	I,
		Range const &	J
	)

resize the container:

• call shift(I.begin(), J.begin()
• call popBackCols() (insertRows()) and/or popBackCols() (popBackRows()). The implicit assumption made by this method is that it is easier and faster to add column than add rows to the 2D container.

  Parameters

  I	the new range for the rows of the container
  J	the new range for the columns of the container

Definition at line 108 of file STK_DataFrame.cpp.

{
  // check if there is something to do
  if ((rows() == I) && (cols() == J)) return;
  //  translate beg
  shift(I.begin(), J.begin());
  // number of rows to del or add
  int rinc = I.lastIdx() - lastIdxRows();
  // number of cols to del or add
  int cinc = J.lastIdx() - lastIdxCols();
  // check if we add cols
  if (cinc >=0)   // work first on rows
  {
    if (rinc < 0) popBackRows(-rinc); // less rows
    else          pushBackRows(rinc); // more rows
    pushBackCols(cinc); // add columns
  }
  else // work first on columns
  {
    popBackCols(-cinc); // remove columns
    if (rinc < 0) popBackRows(-rinc); // less rows
    else          pushBackRows(rinc); // more rows
  }
}

References cols(), lastIdxCols(), lastIdxRows(), popBackCols(), popBackRows(), pushBackCols(), pushBackRows(), rows(), and shift().

rows()

RowRange const & STK::DataFrame::rows ( ) const

inline

Returns

the range of the rows of the container

Definition at line 83 of file STK_DataFrame.h.

{ return Base2D::rows();}

References STK::IContainer2D< UnknownSize, UnknownSize >::rows().

Referenced by resize().

shift() [1/2]

void STK::DataFrame::shift

(

int const &

cbeg = 1

)

New beginning index for the object.

Parameters

cbeg	the index of the first column of the data-frame

Definition at line 134 of file STK_DataFrame.cpp.

{
  // list1D shift
  Base::shift(cbeg);
  // IContainer2D shift for Col
  shiftCols(cbeg);
}

References STK::ITContainer1D< Derived >::shift(), and STK::IContainer2D< UnknownSize, UnknownSize >::shiftCols().

Referenced by resize(), and shift().

shift() [2/2]

void STK::DataFrame::shift	(	int const &	rbeg,
		int const &	cbeg
	)

New beginning index for the object.

Parameters

rbeg	the index of the first row of the data-frame
cbeg	the index of the first column of the data-frame

Definition at line 143 of file STK_DataFrame.cpp.

{
 if (beginRows() == rbeg && beginCols() == cbeg) return;
 if (isRef())
 { STKRUNTIME_ERROR_2ARG(DataFrame::shift,rbeg,cbeg,cannot operate on reference); }
  // list1D shift
  shift(cbeg);
  // For each column update Variable
  for (int j=begin(); j<=lastIdx(); j++)
    if (elt(j)) { elt(j)->shift(rbeg);}
  // update range of the rows
  shiftRows(rbeg);
}

References STK::List1D< IVariable * >::begin(), beginCols(), beginRows(), elt(), STK::TRef<-1 >::isRef(), STK::List1D< IVariable * >::lastIdx(), STK::IVariable::shift(), shift(), STK::IContainer2D< UnknownSize, UnknownSize >::shiftRows(), and STKRUNTIME_ERROR_2ARG.

sizeCols()

int STK::DataFrame::sizeCols ( ) const

inline

Returns

the number of columns

Definition at line 98 of file STK_DataFrame.h.

{ return  Base2D::sizeCols();};

References STK::IContainer2D< UnknownSize, UnknownSize >::sizeCols().

Referenced by eraseCols(), STK::ExportToCsv::ExportToCsv(), insertDataFrame(), operator=(), popBackCols(), and pushBackDataFrame().

sizeRows()

int STK::DataFrame::sizeRows ( ) const

inline

Returns

the size of the container

Definition at line 89 of file STK_DataFrame.h.

{ return  Base2D::sizeRows();}

References STK::IContainer2D< UnknownSize, UnknownSize >::sizeRows().

Referenced by STK::ExportToCsv::ExportToCsv(), insertDataFrame(), insertVariable(), merge(), popBackRows(), pushBackDataFrame(), and pushBackVariable().

swapCols()

void STK::DataFrame::swapCols ( int  j1, int  j2  )

inline

Swapping the j1th column and the j2th column.

Parameters

j1	index of the first column to swap
j2	index of the second column to swap

Definition at line 146 of file STK_DataFrame.h.

    { Base::swap(j1, j2);}

References STK::List1D< IVariable * >::swap().

writeDataFrame()

void STK::DataFrame::writeDataFrame	(	ostream &	os,
		int const &	left,
		int const &	right
	)		const

write a DataFrame to the output stream os.

Definition at line 484 of file STK_DataFrame.cpp.

{
  // Export  to csv the DataFrame
  ExportToCsv csv(*this);
  // get the csv
  ReadWriteCsv* pData = csv.p_readWriteCsv();
  // set delimiters to blank
  pData->setDelimiters(_T(" "));
  // write the csv
  pData->writeSelection(os, beginRows(), lastIdxRows(), left, right);
}

References _T, beginRows(), and lastIdxRows().

Referenced by STK::operator<<().

---

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

• STK_DataFrame.h
• STK_DataFrame.cpp