SAGA API  v9.6
Public Member Functions | List of all members
CSG_Array Class Reference

#include <api_core.h>

Public Member Functions

 CSG_Array (void)
 
 ~CSG_Array (void)
 
 CSG_Array (const CSG_Array &Array)
 
void * Create (const CSG_Array &Array)
 
 CSG_Array (size_t Value_Size, sLong nValues=0, TSG_Array_Growth Growth=TSG_Array_Growth::SG_ARRAY_GROWTH_0)
 
void * Create (size_t Value_Size, sLong nValues=0, TSG_Array_Growth Growth=TSG_Array_Growth::SG_ARRAY_GROWTH_0)
 
bool Destroy (void)
 
CSG_Array & operator= (const CSG_Array &Array)
 
bool Set_Growth (TSG_Array_Growth Growth)
 
TSG_Array_Growth Get_Growth (void) const
 
size_t Get_Value_Size (void) const
 
sLong Get_Size (void) const
 
size_t Get_uSize (void) const
 
void * Get_Entry (sLong Index) const
 Returns a pointer to the memory address of the requested variable. You have to type cast and dereference the pointer to get access to the variable itself. More...
 
void * operator[] (sLong Index) const
 
bool Del_Entry (sLong Index, bool bShrink=true)
 
void * Get_Array (void) const
 
void * Get_Array (sLong nValues)
 
bool Set_Array (sLong nValues, bool bShrink=true)
 
bool Set_Array (sLong nValues, void **pArray, bool bShrink=true)
 
bool Inc_Array (sLong nValues=1)
 
bool Inc_Array (void **pArray)
 
bool Dec_Array (bool bShrink=true)
 
bool Dec_Array (void **pArray, bool bShrink=true)
 

Detailed Description

Definition at line 307 of file api_core.h.

Constructor & Destructor Documentation

◆ CSG_Array() [1/3]

CSG_Array::CSG_Array ( void  )

Definition at line 230 of file api_memory.cpp.

◆ ~CSG_Array()

CSG_Array::~CSG_Array ( void  )

Definition at line 286 of file api_memory.cpp.

References Destroy().

◆ CSG_Array() [2/3]

CSG_Array::CSG_Array ( const CSG_Array &  Array)

Definition at line 241 of file api_memory.cpp.

References Create().

◆ CSG_Array() [3/3]

CSG_Array::CSG_Array ( size_t  Value_Size,
sLong  nValues = 0,
TSG_Array_Growth  Growth = TSG_Array_Growth::SG_ARRAY_GROWTH_0 
)

Definition at line 266 of file api_memory.cpp.

References Create().

Member Function Documentation

◆ Create() [1/2]

void * CSG_Array::Create ( const CSG_Array &  Array)

Definition at line 250 of file api_memory.cpp.

References Destroy(), and Get_Array().

Referenced by CSG_PointCloud::_On_Construction(), CSG_Table::_On_Construction(), CSG_Simple_Statistics::Create(), CSG_Array_Int::Create(), CSG_Array_Pointer::Create(), CSG_Array_sLong::Create(), CSG_Cluster_Analysis::Create(), CSG_Array(), CSG_Points::CSG_Points(), CSG_Points_3D::CSG_Points_3D(), CSG_Points_Int::CSG_Points_Int(), CSG_Stack::CSG_Stack(), and CSG_Vector::CSG_Vector().

◆ Create() [2/2]

void * CSG_Array::Create ( size_t  Value_Size,
sLong  nValues = 0,
TSG_Array_Growth  Growth = TSG_Array_Growth::SG_ARRAY_GROWTH_0 
)

Definition at line 275 of file api_memory.cpp.

References Destroy(), and Get_Array().

◆ Dec_Array() [1/2]

bool CSG_Array::Dec_Array ( bool  bShrink = true)

Definition at line 425 of file api_memory.cpp.

References Set_Array().

Referenced by CSG_Table::_Del_Selection(), CSG_MetaData::Del_Child(), CSG_Vector::Del_Row(), and CSG_Stack::Get_Record_Pop().

◆ Dec_Array() [2/2]

bool CSG_Array::Dec_Array ( void **  pArray,
bool  bShrink = true 
)

Definition at line 430 of file api_memory.cpp.

References Set_Array().

◆ Del_Entry()

bool CSG_Array::Del_Entry ( sLong  Index,
bool  bShrink = true 
)

Definition at line 436 of file api_memory.cpp.

References Set_Array().

◆ Destroy()

bool CSG_Array::Destroy ( void  )

Definition at line 291 of file api_memory.cpp.

References SG_FREE_SAFE.

Referenced by CSG_Simple_Statistics::Add(), Create(), CSG_MetaData::Del_Children(), CSG_PointCloud::Del_Points(), CSG_Cluster_Analysis::Destroy(), CSG_MetaData::Destroy(), CSG_PRQuadTree::Destroy(), CSG_Simple_Statistics::Invalidate(), CSG_PointCloud::Select(), Set_Array(), CSG_Simple_Statistics::Set_Count(), and ~CSG_Array().

◆ Get_Array() [1/2]

void* CSG_Array::Get_Array ( sLong  nValues)
inline

Definition at line 337 of file api_core.h.

◆ Get_Array() [2/2]

void* CSG_Array::Get_Array ( void  ) const
inline

Definition at line 336 of file api_core.h.

Referenced by CSG_Table::_Del_Selection(), CSG_Simple_Statistics::Add(), CSG_Simple_Statistics::Add_Value(), CSG_Points::Assign(), CSG_Points_3D::Assign(), CSG_Points_Int::Assign(), Create(), CSG_Array_Int::Create(), CSG_Array_Pointer::Create(), CSG_Array_sLong::Create(), CSG_MetaData::Del_Child(), CSG_MetaData::Destroy(), CSG_Matrix::Get_Determinant(), CSG_Simple_Statistics::Get_Gini(), CSG_Simple_Statistics::Get_Quantile(), CSG_Stack::Get_Record_Pop(), CSG_MetaData::Ins_Child(), CSG_Table::Ins_Record(), CSG_MetaData::Mov_Child(), CSG_Matrix::Set_Inverse(), SG_Matrix_Solve(), and CSG_MetaData::to_XML().

◆ Get_Entry()

void* CSG_Array::Get_Entry ( sLong  Index) const
inline

Returns a pointer to the memory address of the requested variable. You have to type cast and dereference the pointer to get access to the variable itself.

Definition at line 331 of file api_core.h.

Referenced by CSG_Table::_Set_Selection(), CSG_Points::Add(), CSG_Points_3D::Add(), CSG_Points_Int::Add(), CSG_Stack::Get_Record(), CSG_Stack::Get_Record_Pop(), CSG_Stack::Get_Record_Push(), CSG_Table::Get_Selection_Index(), CSG_Table::Inv_Selection(), and CSG_Cluster_Analysis::Set_Feature().

◆ Get_Growth()

TSG_Array_Growth CSG_Array::Get_Growth ( void  ) const
inline

Definition at line 324 of file api_core.h.

◆ Get_Size()

sLong CSG_Array::Get_Size ( void  ) const
inline

Definition at line 327 of file api_core.h.

Referenced by CSG_Table::_Add_Selection(), CSG_Table::_Del_Selection(), CSG_Simple_Statistics::_Evaluate(), CSG_Table::_Set_Selection(), CSG_Simple_Statistics::Add(), CSG_Points::Add(), CSG_Points_3D::Add(), CSG_Points_Int::Add(), CSG_Points::Assign(), CSG_Points_3D::Assign(), CSG_Points_Int::Assign(), CSG_Simple_Statistics::Get_Gini(), CSG_Simple_Statistics::Get_IndexOfMaximum(), CSG_Simple_Statistics::Get_IndexOfMinimum(), CSG_PRQuadTree::Get_Nearest_Points(), CSG_Simple_Statistics::Get_nValues_Above(), CSG_Simple_Statistics::Get_nValues_Below(), CSG_Simple_Statistics::Get_Quantile(), CSG_Stack::Get_Record_Pop(), CSG_Stack::Get_Record_Push(), CSG_Table::Get_Selection(), CSG_Table::Get_Selection_Count(), CSG_Table::Get_Selection_Index(), CSG_Table::Ins_Record(), CSG_Table::Inv_Selection(), and CSG_MetaData::to_XML().

◆ Get_uSize()

size_t CSG_Array::Get_uSize ( void  ) const
inline

Definition at line 328 of file api_core.h.

Referenced by CSG_Stack::Get_Size().

◆ Get_Value_Size()

size_t CSG_Array::Get_Value_Size ( void  ) const
inline

Definition at line 326 of file api_core.h.

Referenced by CSG_Simple_Statistics::Add_Value(), CSG_Points::Assign(), CSG_Points_3D::Assign(), CSG_Points_Int::Assign(), CSG_Stack::Get_Record_Pop(), and CSG_Stack::Get_RecordSize().

◆ Inc_Array() [1/2]

bool CSG_Array::Inc_Array ( sLong  nValues = 1)

Definition at line 414 of file api_memory.cpp.

References Set_Array().

Referenced by CSG_Table::_Add_Selection(), CSG_Points::Add(), CSG_Points_3D::Add(), CSG_Points_Int::Add(), CSG_Cluster_Analysis::Add_Element(), CSG_Vector::Add_Row(), CSG_Simple_Statistics::Add_Value(), CSG_Stack::Get_Record_Push(), and CSG_MetaData::Ins_Child().

◆ Inc_Array() [2/2]

bool CSG_Array::Inc_Array ( void **  pArray)

Definition at line 419 of file api_memory.cpp.

References Set_Array().

◆ operator=()

CSG_Array& CSG_Array::operator= ( const CSG_Array &  Array)
inline

Definition at line 321 of file api_core.h.

◆ operator[]()

void* CSG_Array::operator[] ( sLong  Index) const
inline

Definition at line 332 of file api_core.h.

◆ Set_Array() [1/2]

bool CSG_Array::Set_Array ( sLong  nValues,
bool  bShrink = true 
)

Definition at line 310 of file api_memory.cpp.

References Destroy(), SG_ARRAY_GROWTH_0, and SG_Realloc().

Referenced by CSG_Simple_Statistics::Add(), CSG_Vector::Add_Rows(), CSG_Points::Assign(), CSG_Points_3D::Assign(), CSG_Points_Int::Assign(), CSG_Stack::Clear(), CSG_Vector::Create(), Dec_Array(), Del_Entry(), CSG_PointCloud::Del_Points(), CSG_Vector::Del_Rows(), CSG_PointCloud::Del_Selection(), CSG_Table::Del_Selection(), CSG_Stack::Destroy(), CSG_Vector::Destroy(), Inc_Array(), CSG_PointCloud::Inv_Selection(), CSG_Table::Inv_Selection(), and Set_Array().

◆ Set_Array() [2/2]

bool CSG_Array::Set_Array ( sLong  nValues,
void **  pArray,
bool  bShrink = true 
)

Definition at line 399 of file api_memory.cpp.

References Set_Array().

◆ Set_Growth()

bool CSG_Array::Set_Growth ( TSG_Array_Growth  Growth)

Definition at line 302 of file api_memory.cpp.

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