include/opencascade/math_IntegerVector.hxx

0001 // Copyright (c) 1997-1999 Matra Datavision
0002 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0003 //
0004 // This file is part of Open CASCADE Technology software library.
0005 //
0006 // This library is free software; you can redistribute it and/or modify it under
0007 // the terms of the GNU Lesser General Public License version 2.1 as published
0008 // by the Free Software Foundation, with special exception defined in the file
0009 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0010 // distribution for complete text of the license and disclaimer of any warranty.
0011 //
0012 // Alternatively, this file may be used under the terms of Open CASCADE
0013 // commercial license or contractual agreement.
0014
0015 #ifndef _math_IntegerVector_HeaderFile
0016 #define _math_IntegerVector_HeaderFile
0017
0018 #include <math_VectorBase.hxx>
0019
0020 //! This class implements the real IntegerVector abstract data type.
0021 //! IntegerVectors can have an arbitrary range which must be define at
0022 //! the declaration and cannot be changed after this declaration.
0023 //! Example:
0024 //! @code
0025 //!    math_IntegerVector V1(-3, 5); // an IntegerVector with range [-3..5]
0026 //! @endcode
0027 //!
0028 //! IntegerVector is copied through assignment:
0029 //! @code
0030 //!    math_IntegerVector V2( 1, 9);
0031 //!    ....
0032 //!    V2 = V1;
0033 //!    V1(1) = 2.0; // the IntegerVector V2 will not be modified.
0034 //! @endcode
0035 //!
0036 //! The Exception RangeError is raised when trying to access outside
0037 //! the range of an IntegerVector :
0038 //! @code
0039 //!    V1(11) = 0 // --> will raise RangeError;
0040 //! @endcode
0041 //!
0042 //! The Exception DimensionError is raised when the dimensions of two
0043 //! IntegerVectors are not compatible :
0044 //! @code
0045 //!    math_IntegerVector V3(1, 2);
0046 //!    V3 = V1;    // --> will raise DimensionError;
0047 //!    V1.Add(V3)  // --> will raise DimensionError;
0048 //! @endcode
0049 using math_IntegerVector = math_VectorBase<int>;
0050
0051 #endif
0052