# FoundationClasses
TKMath
math

# math_IntegerVector Class Reference

This class implements the real IntegerVector abstract data type.
IntegerVectors can have an arbitrary range which must be define at
the declaration and cannot be changed after this declaration.
Example: math_IntegerVector V1(-3, 5); // an IntegerVector with
range [-3..5]
.

`#include <math_IntegerVector.hxx>`

## Public Member Functions

void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
Standard_EXPORT | math_IntegerVector (const Standard_Integer First, const Standard_Integer Last)
| contructs an IntegerVector in the range [Lower..Upper]
Standard_EXPORT | math_IntegerVector (const Standard_Integer First, const Standard_Integer Last, const Standard_Integer InitialValue)
| contructs an IntegerVector in the range [Lower..Upper] with all the elements set to InitialValue.
Standard_EXPORT void | Init (const Standard_Integer InitialValue)
| Initialize an IntegerVector with all the elements set to InitialValue. .
Standard_EXPORT | math_IntegerVector (const Standard_Address Tab, const Standard_Integer First, const Standard_Integer Last)
| constructs an IntegerVector in the range [Lower..Upper] which share the "c array" Tab.
Standard_EXPORT | math_IntegerVector (const math_IntegerVector &Other)
| constructs a copy for initialization. An exception is raised if the lengths of the IntegerVectors are different.
Standard_Integer | Length () const
| returns the length of an IntegerVector
Standard_Integer | Lower () const
| returns the value of the Lower index of an IntegerVector.
Standard_Integer | Upper () const
| returns the value of the Upper index of an IntegerVector.
Standard_EXPORT Standard_Real | Norm () const
| returns the value of the norm of an IntegerVector.
Standard_EXPORT Standard_Real | Norm2 () const
| returns the value of the square of the norm of an IntegerVector.
Standard_EXPORT Standard_Integer | Max () const
| returns the value of the Index of the maximum element of an IntegerVector.
Standard_EXPORT Standard_Integer | Min () const
| returns the value of the Index of the minimum element of an IntegerVector.
Standard_EXPORT void | Invert ()
| inverses an IntegerVector.
Standard_EXPORT math_IntegerVector | Inverse () const
| returns the inverse IntegerVector of an IntegerVector.
Standard_EXPORT void | Set (const Standard_Integer I1, const Standard_Integer I2, const math_IntegerVector &V)
| sets an IntegerVector from <i1> to <i2> to the IntegerVector <v>; An exception is raised if I1<LowerIndex or I2>UpperIndex or I1>I2. An exception is raised if I2-I1+1 is different from the Length of V.
Standard_EXPORT math_IntegerVector | Slice (const Standard_Integer I1, const Standard_Integer I2) const
| slices the values of the IntegerVector between <i1> and <i2>: Example: [2, 1, 2, 3, 4, 5] becomes [2, 4, 3, 2, 1, 5] between 2 and 5. An exception is raised if I1<LowerIndex or I2>UpperIndex.
Standard_EXPORT void | Multiply (const Standard_Integer Right)
| returns the product of an IntegerVector by an integer value.
void | operator *= (const Standard_Integer Right)
Standard_EXPORT math_IntegerVector | Multiplied (const Standard_Integer Right) const
| returns the product of an IntegerVector by an integer value.
math_IntegerVector | operator * (const Standard_Integer Right) const
Standard_EXPORT math_IntegerVector | TMultiplied (const Standard_Integer Right) const
| returns the product of a vector and a real value.
Standard_EXPORT void | Add (const math_IntegerVector &Right)
| adds the IntegerVector <right> to an IntegerVector. An exception is raised if the IntegerVectors have not the same length. An exception is raised if the lengths are not equal.
void | operator+= (const math_IntegerVector &Right)
Standard_EXPORT math_IntegerVector | Added (const math_IntegerVector &Right) const
| adds the IntegerVector <right> to an IntegerVector. An exception is raised if the IntegerVectors have not the same length. An exception is raised if the lengths are not equal.
math_IntegerVector | operator+ (const math_IntegerVector &Right) const
Standard_EXPORT void | Add (const math_IntegerVector &Left, const math_IntegerVector &Right)
| sets an IntegerVector to the sum of the IntegerVector <left> and the IntegerVector <right>. An exception is raised if the lengths are different.
Standard_EXPORT void | Subtract (const math_IntegerVector &Left, const math_IntegerVector &Right)
| sets an IntegerVector to the substraction of <right> from <left>. An exception is raised if the IntegerVectors have not the same length.
Standard_Integer & | Value (const Standard_Integer Num) const
| accesses (in read or write mode) the value of index Num of an IntegerVector.
Standard_Integer & | operator() (const Standard_Integer Num) const
Standard_EXPORT math_IntegerVector & | Initialized (const math_IntegerVector &Other)
| Initialises an IntegerVector by copying <other>. An exception is raised if the Lengths are different. .
math_IntegerVector & | operator= (const math_IntegerVector &Other)
Standard_EXPORT Standard_Integer | Multiplied (const math_IntegerVector &Right) const
| returns the inner product of 2 IntegerVectors. An exception is raised if the lengths are not equal.
Standard_Integer | operator * (const math_IntegerVector &Right) const
Standard_EXPORT math_IntegerVector | Opposite ()
| returns the opposite of an IntegerVector.
math_IntegerVector | operator- ()
Standard_EXPORT void | Subtract (const math_IntegerVector &Right)
| returns the subtraction of <right> from <me>. An exception is raised if the IntegerVectors have not the same length.
void | operator-= (const math_IntegerVector &Right)
Standard_EXPORT math_IntegerVector | Subtracted (const math_IntegerVector &Right) const
| returns the subtraction of <right> from <me>. An exception is raised if the IntegerVectors have not the same length.
math_IntegerVector | operator- (const math_IntegerVector &Right) const
Standard_EXPORT void | Multiply (const Standard_Integer Left, const math_IntegerVector &Right)
| returns the multiplication of an integer by an IntegerVector.
Standard_EXPORT void | Dump (Standard_OStream &o) const
| Prints on the stream o information on the current state of the object. Is used to redefine the operator <<. .

## Protected Member Functions

Standard_EXPORT void | SetFirst (const Standard_Integer First)
| is used internally to set the Lower value of the IntegerVector.

## Private Attributes

Standard_Integer | FirstIndex
Standard_Integer | LastIndex
math_SingleTabOfInteger | Array

## Friends

math_IntegerVector | operator * (const Standard_Integer Left, const math_IntegerVector &Right)

## Constructor & Destructor Documentation

Standard_EXPORT math_IntegerVector::math_IntegerVector | ( | const Standard_Integer | First,
|  | const Standard_Integer | Last
| ) |

Standard_EXPORT math_IntegerVector::math_IntegerVector | ( | const Standard_Integer | First,
|  | const Standard_Integer | Last,
|  | const Standard_Integer | InitialValue
| ) |

Standard_EXPORT math_IntegerVector::math_IntegerVector | ( | const Standard_Address | Tab,
|  | const Standard_Integer | First,
|  | const Standard_Integer | Last
| ) |

Standard_EXPORT math_IntegerVector::math_IntegerVector | ( | const math_IntegerVector & | Other | ) |

## Member Function Documentation

Standard_EXPORT void math_IntegerVector::Add | ( | const math_IntegerVector & | Left,
|  | const math_IntegerVector & | Right
| ) |

Standard_EXPORT void math_IntegerVector::Add | ( | const math_IntegerVector & | Right | ) |

Standard_EXPORT math_IntegerVector math_IntegerVector::Added | ( | const math_IntegerVector & | Right | ) | const

Standard_EXPORT void math_IntegerVector::Dump | ( | Standard_OStream & | o | ) | const

Standard_EXPORT void math_IntegerVector::Init | ( | const Standard_Integer | InitialValue | ) |

Standard_EXPORT math_IntegerVector& math_IntegerVector::Initialized | ( | const math_IntegerVector & | Other | ) |

Standard_EXPORT math_IntegerVector math_IntegerVector::Inverse | ( |  | ) | const

Standard_EXPORT void math_IntegerVector::Invert | ( |  | ) |

Standard_Integer math_IntegerVector::Length | ( |  | ) | const`[inline]`

Standard_Integer math_IntegerVector::Lower | ( |  | ) | const`[inline]`

Standard_EXPORT Standard_Integer math_IntegerVector::Max | ( |  | ) | const

Standard_EXPORT Standard_Integer math_IntegerVector::Min | ( |  | ) | const

Standard_EXPORT Standard_Integer math_IntegerVector::Multiplied | ( | const math_IntegerVector & | Right | ) | const

Standard_EXPORT math_IntegerVector math_IntegerVector::Multiplied | ( | const Standard_Integer | Right | ) | const

Standard_EXPORT void math_IntegerVector::Multiply | ( | const Standard_Integer | Left,
|  | const math_IntegerVector & | Right
| ) |

Standard_EXPORT void math_IntegerVector::Multiply | ( | const Standard_Integer | Right | ) |

Standard_EXPORT Standard_Real math_IntegerVector::Norm | ( |  | ) | const

Standard_EXPORT Standard_Real math_IntegerVector::Norm2 | ( |  | ) | const

Standard_Integer math_IntegerVector::operator * | ( | const math_IntegerVector & | Right | ) | const`[inline]`

math_IntegerVector math_IntegerVector::operator * | ( | const Standard_Integer | Right | ) | const`[inline]`

void math_IntegerVector::operator *= | ( | const Standard_Integer | Right | ) | `[inline]`

void math_IntegerVector::operator delete | ( | void * | anAddress | ) | `[inline]`

void* math_IntegerVector::operator new | ( | size_t | size | ) | `[inline]`

void* math_IntegerVector::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

Standard_Integer& math_IntegerVector::operator() | ( | const Standard_Integer | Num | ) | const`[inline]`

math_IntegerVector math_IntegerVector::operator+ | ( | const math_IntegerVector & | Right | ) | const`[inline]`

void math_IntegerVector::operator+= | ( | const math_IntegerVector & | Right | ) | `[inline]`

math_IntegerVector math_IntegerVector::operator- | ( | const math_IntegerVector & | Right | ) | const`[inline]`

math_IntegerVector math_IntegerVector::operator- | ( |  | ) | `[inline]`

void math_IntegerVector::operator-= | ( | const math_IntegerVector & | Right | ) | `[inline]`

math_IntegerVector& math_IntegerVector::operator= | ( | const math_IntegerVector & | Other | ) | `[inline]`

Standard_EXPORT math_IntegerVector math_IntegerVector::Opposite | ( |  | ) |

Standard_EXPORT void math_IntegerVector::Set | ( | const Standard_Integer | I1,
|  | const Standard_Integer | I2,
|  | const math_IntegerVector & | V
| ) |

Standard_EXPORT void math_IntegerVector::SetFirst | ( | const Standard_Integer | First | ) | `[protected]`

Standard_EXPORT math_IntegerVector math_IntegerVector::Slice | ( | const Standard_Integer | I1,
|  | const Standard_Integer | I2
| ) | const

Standard_EXPORT void math_IntegerVector::Subtract | ( | const math_IntegerVector & | Right | ) |

Standard_EXPORT void math_IntegerVector::Subtract | ( | const math_IntegerVector & | Left,
|  | const math_IntegerVector & | Right
| ) |

Standard_EXPORT math_IntegerVector math_IntegerVector::Subtracted | ( | const math_IntegerVector & | Right | ) | const

Standard_EXPORT math_IntegerVector math_IntegerVector::TMultiplied | ( | const Standard_Integer | Right | ) | const

Standard_Integer math_IntegerVector::Upper | ( |  | ) | const`[inline]`

Standard_Integer & math_IntegerVector::Value | ( | const Standard_Integer | Num | ) | const`[inline]`

## Friends And Related Function Documentation

math_IntegerVector operator * | ( | const Standard_Integer | Left,
|  | const math_IntegerVector & | Right
| ) | `[friend]`

## Field Documentation

math_SingleTabOfInteger math_IntegerVector::Array `[private]`

Standard_Integer math_IntegerVector::FirstIndex `[private]`

Standard_Integer math_IntegerVector::LastIndex `[private]`

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

- math_IntegerVector.hxx
- math_IntegerVector.lxx