0024042: Performance improvements: Foundation Classes

[occt.git] / src / TCollection / TCollection_Array2.lxx

// Copyright (c) 1998-1999 Matra Datavision
// Copyright (c) 1999-2012 OPEN CASCADE SAS
//
// The content of this file is subject to the Open CASCADE Technology Public
// License Version 6.5 (the "License"). You may not use the content of this file
// except in compliance with the License. Please obtain a copy of the License
// at http://www.opencascade.org and read it completely before using this file.
//
// The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
// main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
//
// The Original Code and all software distributed under the License is
// distributed on an "AS IS" basis, without warranty of any kind, and the
// Initial Developer hereby disclaims all such warranties, including without
// limitation, any warranties of merchantability, fitness for a particular
// purpose or non-infringement. Please see the License for the specific terms
// and conditions governing the rights and limitations under the License.

#include <Standard.hxx>
#include <Standard_OutOfRange.hxx>

#include Array2Item_hxx

//=======================================================================
//function : TCollection_Array2
//purpose  : 
//=======================================================================

inline TCollection_Array2::TCollection_Array2 (const Standard_Integer R1, 
                                               const Standard_Integer R2,
                                               const Standard_Integer C1, 
                                               const Standard_Integer C2) :
       myLowerRow(R1),
       myLowerColumn(C1),
       myUpperRow(R2),
       myUpperColumn(C2),
       myDeletable(Standard_True)
{
  Allocate ();
}

//=======================================================================
//function : TCollection_Array2
//purpose  : User allocated data
//=======================================================================

inline TCollection_Array2::TCollection_Array2 (const Array2Item& Item,
					const Standard_Integer R1, 
					const Standard_Integer R2,
					const Standard_Integer C1, 
					const Standard_Integer C2) :
       myLowerRow(R1),
       myLowerColumn(C1),
       myUpperRow(R2),
       myUpperColumn(C2),
       myDeletable(Standard_False),
       myData((void*)&Item)
{
  Allocate ();
}

//=======================================================================
//function : Init
//purpose  : 
//=======================================================================

inline void TCollection_Array2::Init (const Array2Item& V) 
{
  Standard_Integer Size = RowLength() * ColLength();
  Array2Item* p = &(ChangeValue(myLowerRow,myLowerColumn));
  for (Standard_Integer I = 0; I < Size ; I++) p[I] = V;
}

//=======================================================================
//function : Destroy
//purpose  : 
//=======================================================================

inline void TCollection_Array2::Destroy () 
{
  Array2Item** anItemPtr = ((Array2Item**)myData + myLowerRow);
  
  // delete the data
  //
  if (myDeletable) 
    delete [] &ChangeValue(myLowerRow,myLowerColumn);

  // delete the indirection table
  Standard::Free((void*&)anItemPtr);
}

//=======================================================================
//function : ColLength
//purpose  : 
//=======================================================================
inline Standard_Integer TCollection_Array2::ColLength () const
{
	return myUpperRow - myLowerRow + 1 ;
}

//=======================================================================
//function : LowerCol
//purpose  : 
//=======================================================================
inline Standard_Integer TCollection_Array2::LowerCol () const
{
	return myLowerColumn ;
}

//=======================================================================
//function : LowerRow
//purpose  : 
//=======================================================================
inline Standard_Integer TCollection_Array2::LowerRow () const
{
	return myLowerRow;
}

//=======================================================================
//function : RowLength
//purpose  : 
//=======================================================================
inline Standard_Integer TCollection_Array2::RowLength () const
{
	return myUpperColumn - myLowerColumn + 1 ;
}

//=======================================================================
//function : UpperRow
//purpose  : 
//=======================================================================
inline Standard_Integer TCollection_Array2::UpperRow () const
{
	return myUpperRow ;
}

//=======================================================================
//function : UpperCol
//purpose  : 
//=======================================================================
inline Standard_Integer TCollection_Array2::UpperCol () const
{
	return myUpperColumn ;
}

//=======================================================================
//function : SetValue
//purpose  : 
//=======================================================================

inline void TCollection_Array2::SetValue ( const Standard_Integer Row,
                                    const Standard_Integer Col,
                                    const Array2Item& Value )
{
  Standard_OutOfRange_Raise_if((Row < myLowerRow || Row > myUpperRow ||
                                Col < myLowerColumn || Col > myUpperColumn),
                               NULL);

  ((Array2Item **)myData)[Row][Col] = Value ;
}

//=======================================================================
//function : Value
//purpose  : 
//=======================================================================
inline const Array2Item& TCollection_Array2::Value(const Standard_Integer Row,
                                            const Standard_Integer Col) const
{
  Standard_OutOfRange_Raise_if((Row < myLowerRow || Row > myUpperRow ||
                                Col < myLowerColumn || Col > myUpperColumn),
                               NULL);

  return ((Array2Item **)myData)[Row][Col];
} 

//=======================================================================
//function : ChangeValue
//purpose  : 
//=======================================================================

inline Array2Item& TCollection_Array2::ChangeValue(const Standard_Integer Row,
                                            const Standard_Integer Col)
{
  Standard_OutOfRange_Raise_if((Row < myLowerRow || Row > myUpperRow ||
                                Col < myLowerColumn || Col > myUpperColumn),
                               NULL);

  return ((Array2Item **)myData)[Row][Col];
}