PbArray.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef _PB_ARRAY_
#define _PB_ARRAY_
#include <string.h>
 
#include <Inventor/SbBasic.h>
 
#include <Inventor/STL/vector>
 
#define PO_ARRAY_HEADER(className,valueType) \
 \
 \
 \
 \
 \
 
class  className { \
public: \
  className(): \
    m_array(0), \
    m_allocatedSize(0), \
    m_lastInd(-1), \
    m_extend(10) \
  {}; \  \
  className(int init_size, int extend=10);   \
  className(const className& other_array); \
  ~className(); \
\
  /* access/insertion methods */ \ \
  const valueType* get() const;  \
\ \
  valueType get(int index) const;  \
\ \
  int find(valueType val) const;  \
\ \
  void set(int index, valueType val);    \
\ \
  int add(valueType val);                 \
\ \
  int add(int num_val, const valueType* val);             \
\
  /* special operators */ \ \
  className &operator=(const className& other_array);     \
\ \
  className &operator=(const std::vector<valueType>& other_array);     \
\ \
  void operator+=(const className& other_array); \
\ \
  void operator+=(valueType val);                         \
\
  valueType& operator[](int index);                              \
  const valueType& operator[](int index) const; \
\ \
   friend int operator ==(const className &array_1, const className &array_2); \
\ \
   friend int operator !=(const className &array_1, const className &array_2) \
    { return !(array_1 == array_2); }                                         \
\ \
  void setCapacity(int capacity, int extend); \
\
  /* miscellaneous methods */   \
  void squeeze();                           \
\ \
  int getCapacity() const;  \
\ \
  int getNum() const;  \
\ \
  void increasingSort();      \
\ \
  void decreasingSort();     \
\ \
\
  void empty();  \
  /* friend ostream& operator<<(ostream &stream, const className &array); */ \
\
private: \
  valueType *m_array;                                      \
  int m_allocatedSize;                                     \
  int m_lastInd;                                           \
  int m_extend;                                            \
  valueType *resize(int sz);                               \
};  \
/*---------------------------------------------------------------------------*/ \
\
\
/* Get the adress of the internal array */ \
inline const valueType* \
className::get() const {return m_array;} \
 \
/* Get the valueType value at a particular index. */ \
inline valueType  \
className::get(int index) const {return m_array[index];} \
 \
/* Find the first index in the array of a given valueType value (-1 if not found) */ \
inline int  \
className::find(valueType val) const { \
  for ( int i=0; i<=m_lastInd; i++) if (m_array[i]==val) return i; \
  return -1; \
}/*---------------------------------------------------------------------------*/ \
 \
 \
/* Insert valueType value at a specified position in the array. */ \
inline void  \
className::set(int index, valueType val) \
{ \
  if ( index >= m_allocatedSize ) resize(index+1); \
  m_array[index] = val; \
  if ( index > m_lastInd ) m_lastInd = index; \
}/*---------------------------------------------------------------------------*/ \
 \
 \
/* Insert valueType value at the end of the array. Return its location in the array. */ \
inline int  \
className::add(valueType val) \
{ \
  m_lastInd++; \
  if ( m_lastInd >= m_allocatedSize ) resize(m_lastInd+1); \
  m_array[m_lastInd] = val; \
   \
  return m_lastInd; \
}/*---------------------------------------------------------------------------*/ \
 \
 \
inline void  \
className::operator+=(valueType val)  \
{ \
  add(val); \
}/*---------------------------------------------------------------------------*/ \
 \
 \
/* Get valueType value in a const array (location on rhs statement).  */ \
inline const valueType&  \
className::operator[](int index) const \
{ \
  return m_array[index]; \
}/*---------------------------------------------------------------------------*/ \
 \
 \
/* Does insert or get (depending on location on lhs or rhs of statement). Does */ \
/* not do automatic resizing - user's responsibility to range check. */ \
inline valueType&  \
className::operator[](int index) \
{ \
  if (index > m_lastInd) m_lastInd = index;  \
  return m_array[index]; \
}/*---------------------------------------------------------------------------*/ \
 \
 \
/* Get the allocated size of the array */ \
inline int  \
className::getCapacity() const {return m_allocatedSize;} \
 \
 \
/* Returning the maximum index of valueType values inserted so far. */ \
inline int  \
className::getNum() const {return m_lastInd+1;} \
 \
 \
/* Reuse the memory allocated by this array. It appears like */ \
/* no valueType value has been previously inserted. */ \
inline void  \
className::empty() {m_lastInd = -1;} 
 
 
#endif /* _PB_ARRAY_ */