libcascade
PackageApiSyntheticN collection autoGenerated

Generated (page 9 of 9)

OCCT package Generated:…

NCollection_Sequence_handle_Message_Printer

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_MoniTool_Element

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_NCollection_HArray1_double

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_NCollection_HArray1_gp_Pnt

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_NCollection_HArray1_gp_Pnt2d

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_NCollection_HSequence_gp_Pnt

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_NLPlate_HGPPConstraint

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_PCDM_Document

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_Poly_Triangulation

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_STEPSelections_AssemblyComponent

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_ShapeAnalysis_FreeBoundData

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_Standard_Transient

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_StepElement_CurveElementPurposeMember

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_StepElement_CurveElementSectionDefinition

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_StepElement_ElementMaterial

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_StepElement_SurfaceElementPurposeMember

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_StepFEA_Curve3dElementProperty

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_StepFEA_ElementGeometricRelationship

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_StepFEA_ElementRepresentation

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_StepFEA_NodeRepresentation

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_StepRepr_MaterialPropertyRepresentation

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_StepRepr_RepresentationItem

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_Storage_Root

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_TCollection_HAsciiString

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_TCollection_HExtendedString

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_TDF_Attribute

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_TDocStd_ApplicationDelta

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_TDocStd_Document

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_TransferBRep_TransferResultInfo

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_Transfer_Binder

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_Transfer_Finder

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_Units_Quantity

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_Units_Token

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_Units_Unit

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_XCAFDimTolObjects_DatumObject

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_XCAFDimTolObjects_DimensionObject

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_handle_XCAFDimTolObjects_GeomToleranceObject

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

NCollection_Sequence_int

NCollection_BaseSequence

Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n

Constructors(3)

Instance methods(26)

  • Upper(): number

    Method for consistency with other collections.

    Returns

    Upper bound (inclusive) for iteration.

  • IsEmpty(): boolean

    Empty query.

  • Reverse(): void

    Reverse sequence.

  • Exchange(I: number, J: number): void

    Exchange two members.

    Parameters (2)
    • I
    • J
  • Clear(theAllocator?: NCollection_BaseAllocator): void

    Clear the items out, take a new allocator if non null.

    Parameters (1)
    • theAllocator
  • Assign(theOther: NCollection_Sequence_int): NCollection_Sequence_int

    Replace this sequence by the items of theOther. This method does not change the internal allocator.

    Parameters (1)
    • theOther
  • Remove(theIndex: number): void

    Remove one item.

    Parameters (1)
    • theIndex
  • Remove(theFromIndex: number, theToIndex: number): void

    Remove range of items.

    Parameters (2)
    • theFromIndex
    • theToIndex
  • Append(theItem: number): void

    Append one item.

    Parameters (1)
    • theItem
  • Append(theSeq: NCollection_Sequence_int): void

    Append one item.

    Parameters (1)
    • theSeq —
      Mutated in place; read the updated value from this argument after the call.
  • Prepend(theItem: number): void

    Prepend one item.

    Parameters (1)
    • theItem
  • Prepend(theSeq: NCollection_Sequence_int): void

    Prepend one item.

    Parameters (1)
    • theSeq —
      Mutated in place; read the updated value from this argument after the call.
  • InsertBefore(theIndex: number, theItem: number): void

    InsertBefore theIndex theItem.

    Parameters (2)
    • theIndex
    • theItem
  • InsertBefore(theIndex: number, theSeq: NCollection_Sequence_int): void
    Parameters (2)
    • theIndex
    • theSeq
  • InsertAfter(theIndex: number, theSeq: NCollection_Sequence_int): void

    InsertAfter the position of iterator.

    Parameters (2)
    • theIndex
    • theSeq —
      Mutated in place; read the updated value from this argument after the call.
  • InsertAfter(theIndex: number, theItem: number): void

    InsertAfter the position of iterator.

    Parameters (2)
    • theIndex
    • theItem
  • Split(theIndex: number, theSeq: NCollection_Sequence_int): void

    Split in two sequences.

    Parameters (2)
    • theIndex
    • theSeq —
      Mutated in place; read the updated value from this argument after the call.
  • First(): number

    First item access.

  • ChangeFirst(): number

    First item access.

  • Last(): number

    Last item access.

  • ChangeLast(): number

    Last item access.

  • Value(theIndex: number): number

    Constant item access by theIndex.

    Parameters (1)
    • theIndex
  • ChangeValue(theIndex: number): number

    Variable item access by theIndex.

    Parameters (1)
    • theIndex
  • SetValue(theIndex: number, theItem: number): void

    Set item value by theIndex.

    Parameters (2)
    • theIndex
    • theItem
  • At(theIndex: number): number

    0-based checked access independent of Lower()/Upper().

    Parameters (1)
    • theIndex —
      0-based index in [0, Size()-1]
  • ChangeAt(theIndex: number): number

    0-based checked mutable access independent of Lower()/Upper().

    Parameters (1)
    • theIndex —
      0-based index in [0, Size()-1]

NCollection_Shared_NCollection_DynamicArray_BRepMesh_Circle_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_DynamicArray_BRepMesh_Triangle_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_DynamicArray_BRepMesh_Vertex_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_DynamicArray_IMeshData_Edge_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_DynamicArray_TopAbs_Orientation_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_DynamicArray_bool_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_DynamicArray_handle_IMeshData_Edge_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_DynamicArray_handle_IMeshData_Face_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_DynamicArray_handle_IMeshData_PCurve_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_DynamicArray_handle_IMeshData_Wire_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_DynamicArray_int_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_Sequence_Bnd_B2_double_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_Sequence_double_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_NCollection_Sequence_int_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_Shared_Standard_Mutex_void

Standard_Transient

Template defining a class derived from the specified base class and Standard_Transient, and supporting OCCT RTTI.
This provides possibility to use Handes for types not initially intended to be dynamically allocated.
Current limitation is that only copy and constructors with 1-3 arguments are defined, calling those of the argument class (default constructor must be available). It can be improved when perfect forwarding of template arguments is supported by all compilers used for OCCT.
The intent is similar to std::make_shared<> in STL, except that this implementation defines a separate type.

Constructors(1)

NCollection_TListIterator_HLRAlgo_Interference

NCollection_BaseList_Iterator

Purpose: This Iterator class iterates on BaseList of TListNode and is instantiated in List/Set/Queue/Stack Remark: TListIterator is internal class

Constructors(2)

Instance methods(4)

math_VectorBase_double

This class implements the real vector abstract data type. Vectors can have an arbitrary range which must be defined at the declaration and cannot be changed after this declaration.

math_VectorBase<TheItemType>V1(-3,5);//avectorwithrange[-3..5]

Vector are copied through assignment:

math_VectorBase<TheItemType>V2(1,9); .... V2=V1; V1(1)=2.0;//thevectorV2willnotbemodified.

The Exception RangeError is raised when trying to access outside the range of a vector :

V1(11)=0.0//-->willraiseRangeError;

The Exception DimensionError is raised when the dimensions of two vectors are not compatible :

math_VectorBase<TheItemType>V3(1,2); V3=V1;//-->willraiseDimensionError; V1.Add(V3)//-->willraiseDimensionError;

Constructors(5)

Instance methods(37)

  • Init(theInitialValue: number): void

    Initialize all the elements of a vector with "theInitialValue".

    Parameters (1)
    • theInitialValue
  • Length(): number

    Returns the length of a vector.

  • Lower(): number

    Returns the lower index of the vector.

  • Upper(): number

    Returns the upper index of the vector.

  • Norm(): number

    Returns the value or the square of the norm of this vector.

  • Norm2(): number

    Returns the value of the square of the norm of a vector.

  • Max(): number

    Returns the index of the maximum element of a vector. (first found)

  • Min(): number

    Returns the index of the minimum element of a vector. (first found)

  • Normalize(): void

    Normalizes this vector (the norm of the result is equal to 1.0) and assigns the result to this vector Exceptions Standard_NullValue if this vector is null (i.e. if its norm is less than or equal to double::RealEpsilon().

  • Normalized(): math_VectorBase_double

    Normalizes this vector (the norm of the result is equal to 1.0) and creates a new vector Exceptions Standard_NullValue if this vector is null (i.e. if its norm is less than or equal to double::RealEpsilon().

  • Invert(): void

    Inverts this vector and assigns the result to this vector.

  • Inverse(): math_VectorBase_double

    Inverts this vector and creates a new vector.

  • Set(theI1: number, theI2: number, theV: math_VectorBase_double): void

    sets a vector from "theI1" to "theI2" to the vector "theV"; An exception is raised if "theI1" is less than "LowerIndex" or "theI2" is greater than "UpperIndex" or "theI1" is greater than "theI2". An exception is raised if "theI2-theI1+1" is different from the "Length" of "theV".

    Parameters (3)
    • theI1
    • theI2
    • theV
  • Slice(theI1: number, theI2: number): math_VectorBase_double

    Creates a new vector by inverting the values of this vector between indexes "theI1" and "theI2". If the values of this vector were (1., 2., 3., 4.,5., 6.), by slicing it between indexes 2 and 5 the values of the resulting vector are (1., 5., 4., 3., 2., 6.)

    Parameters (2)
    • theI1
    • theI2
  • Multiply(theRight: number): void

    Updates current vector by multiplying each element on current value.

    Parameters (1)
    • theRight
  • Multiply(theLeft: math_VectorBase_double, theRight: math_Matrix): void

    sets a vector to the product of the vector "theLeft" with the matrix "theRight".

    Parameters (2)
    • theLeft
    • theRight
  • Multiply(theLeft: math_Matrix, theRight: math_VectorBase_double): void

    sets a vector to the product of the matrix "theLeft" with the vector "theRight".

    Parameters (2)
    • theLeft
    • theRight
  • Multiply(theLeft: number, theRight: math_VectorBase_double): void

    returns the multiplication of a real by a vector. "me" = "theLeft" * "theRight"

    Parameters (2)
    • theLeft
    • theRight
  • Multiplied(theRight: number): math_VectorBase_double

    returns the product of a vector and a real value.

    Parameters (1)
    • theRight
  • Multiplied(theRight: math_VectorBase_double): number

    returns the inner product of 2 vectors. An exception is raised if the lengths are not equal.

    Parameters (1)
    • theRight
  • Multiplied(theRight: math_Matrix): math_VectorBase_double

    returns the product of a vector by a matrix.

    Parameters (1)
    • theRight
  • TMultiplied(theRight: number): math_VectorBase_double

    returns the product of a vector and a real value.

    Parameters (1)
    • theRight
  • Divide(theRight: number): void

    divides a vector by the value "theRight". An exception is raised if "theRight" = 0.

    Parameters (1)
    • theRight
  • Divided(theRight: number): math_VectorBase_double

    Returns new vector as dividing current vector with the value "theRight". An exception is raised if "theRight" = 0.

    Parameters (1)
    • theRight
  • Add(theRight: math_VectorBase_double): void

    adds the vector "theRight" to a vector. An exception is raised if the vectors have not the same length. Warning In order to avoid time-consuming copying of vectors, it is preferable to use operator += or the function Add whenever possible.

    Parameters (1)
    • theRight
  • Add(theLeft: math_VectorBase_double, theRight: math_VectorBase_double): void

    sets a vector to the sum of the vector "theLeft" and the vector "theRight". An exception is raised if the lengths are different.

    Parameters (2)
    • theLeft
    • theRight
  • Added(theRight: math_VectorBase_double): math_VectorBase_double

    Returns new vector as adding current vector with the value "theRight". An exception is raised if the vectors do not have the same length. An exception is raised if the lengths are not equal.

    Parameters (1)
    • theRight
  • TMultiply(theTLeft: math_Matrix, theRight: math_VectorBase_double): void

    sets a vector to the product of the transpose of the matrix "theTLeft" by the vector "theRight".

    Parameters (2)
    • theTLeft
    • theRight
  • TMultiply(theLeft: math_VectorBase_double, theTRight: math_Matrix): void

    sets a vector to the product of the vector "theLeft" by the transpose of the matrix "theTRight".

    Parameters (2)
    • theLeft
    • theTRight
  • Subtract(theLeft: math_VectorBase_double, theRight: math_VectorBase_double): void

    sets a vector to the Subtraction of the vector theRight from the vector theLeft. An exception is raised if the vectors have not the same length. Warning In order to avoid time-consuming copying of vectors, it is preferable to use operator -= or the function Subtract whenever possible.

    Parameters (2)
    • theLeft
    • theRight
  • Subtract(theRight: math_VectorBase_double): void

    returns the subtraction of "theRight" from "me". An exception is raised if the vectors have not the same length.

    Parameters (1)
    • theRight
  • Value(theNum: number): number

    accesses the value of index "theNum" of a vector.

    Parameters (1)
    • theNum
  • Initialized(theOther: math_VectorBase_double): math_VectorBase_double

    Initialises a vector by copying "theOther". An exception is raised if the Lengths are different.

    Parameters (1)
    • theOther
  • Opposite(): math_VectorBase_double

    returns the opposite of a vector.

  • Subtracted(theRight: math_VectorBase_double): math_VectorBase_double

    returns the subtraction of "theRight" from "me". An exception is raised if the vectors have not the same length.

    Parameters (1)
    • theRight
  • Array1(): NCollection_Array1_double

    Returns the underlying array for interoperability with legacy APIs. Allows passing math_Vector data to functions expecting NCollection_Array1.

  • Resize(theSize: number): void

    Resizes the vector to a new size, keeping the same lower bound. Existing data within the new range is preserved. The method optimizes memory usage:

    • If new size fits in stack buffer (<=32), uses stack allocation
    • If new size requires heap and was already on heap, resizes in place
    • Transitions between stack and heap as needed
    Parameters (1)
    • theSize —
      new size of the vector

math_VectorBase_int

This class implements the real vector abstract data type. Vectors can have an arbitrary range which must be defined at the declaration and cannot be changed after this declaration.

math_VectorBase<TheItemType>V1(-3,5);//avectorwithrange[-3..5]

Vector are copied through assignment:

math_VectorBase<TheItemType>V2(1,9); .... V2=V1; V1(1)=2.0;//thevectorV2willnotbemodified.

The Exception RangeError is raised when trying to access outside the range of a vector :

V1(11)=0.0//-->willraiseRangeError;

The Exception DimensionError is raised when the dimensions of two vectors are not compatible :

math_VectorBase<TheItemType>V3(1,2); V3=V1;//-->willraiseDimensionError; V1.Add(V3)//-->willraiseDimensionError;

Constructors(5)

Instance methods(37)

  • Init(theInitialValue: number): void

    Initialize all the elements of a vector with "theInitialValue".

    Parameters (1)
    • theInitialValue
  • Length(): number

    Returns the length of a vector.

  • Lower(): number

    Returns the lower index of the vector.

  • Upper(): number

    Returns the upper index of the vector.

  • Norm(): number

    Returns the value or the square of the norm of this vector.

  • Norm2(): number

    Returns the value of the square of the norm of a vector.

  • Max(): number

    Returns the index of the maximum element of a vector. (first found)

  • Min(): number

    Returns the index of the minimum element of a vector. (first found)

  • Normalize(): void

    Normalizes this vector (the norm of the result is equal to 1.0) and assigns the result to this vector Exceptions Standard_NullValue if this vector is null (i.e. if its norm is less than or equal to double::RealEpsilon().

  • Normalized(): math_VectorBase_int

    Normalizes this vector (the norm of the result is equal to 1.0) and creates a new vector Exceptions Standard_NullValue if this vector is null (i.e. if its norm is less than or equal to double::RealEpsilon().

  • Invert(): void

    Inverts this vector and assigns the result to this vector.

  • Inverse(): math_VectorBase_int

    Inverts this vector and creates a new vector.

  • Set(theI1: number, theI2: number, theV: math_VectorBase_int): void

    sets a vector from "theI1" to "theI2" to the vector "theV"; An exception is raised if "theI1" is less than "LowerIndex" or "theI2" is greater than "UpperIndex" or "theI1" is greater than "theI2". An exception is raised if "theI2-theI1+1" is different from the "Length" of "theV".

    Parameters (3)
    • theI1
    • theI2
    • theV
  • Slice(theI1: number, theI2: number): math_VectorBase_int

    Creates a new vector by inverting the values of this vector between indexes "theI1" and "theI2". If the values of this vector were (1., 2., 3., 4.,5., 6.), by slicing it between indexes 2 and 5 the values of the resulting vector are (1., 5., 4., 3., 2., 6.)

    Parameters (2)
    • theI1
    • theI2
  • Multiply(theRight: number): void

    Updates current vector by multiplying each element on current value.

    Parameters (1)
    • theRight
  • Multiply(theLeft: math_VectorBase_int, theRight: math_Matrix): void

    sets a vector to the product of the vector "theLeft" with the matrix "theRight".

    Parameters (2)
    • theLeft
    • theRight
  • Multiply(theLeft: math_Matrix, theRight: math_VectorBase_int): void

    sets a vector to the product of the matrix "theLeft" with the vector "theRight".

    Parameters (2)
    • theLeft
    • theRight
  • Multiply(theLeft: number, theRight: math_VectorBase_int): void

    returns the multiplication of a real by a vector. "me" = "theLeft" * "theRight"

    Parameters (2)
    • theLeft
    • theRight
  • Multiplied(theRight: number): math_VectorBase_int

    returns the product of a vector and a real value.

    Parameters (1)
    • theRight
  • Multiplied(theRight: math_VectorBase_int): number

    returns the inner product of 2 vectors. An exception is raised if the lengths are not equal.

    Parameters (1)
    • theRight
  • Multiplied(theRight: math_Matrix): math_VectorBase_int

    returns the product of a vector by a matrix.

    Parameters (1)
    • theRight
  • TMultiplied(theRight: number): math_VectorBase_int

    returns the product of a vector and a real value.

    Parameters (1)
    • theRight
  • Divide(theRight: number): void

    divides a vector by the value "theRight". An exception is raised if "theRight" = 0.

    Parameters (1)
    • theRight
  • Divided(theRight: number): math_VectorBase_int

    Returns new vector as dividing current vector with the value "theRight". An exception is raised if "theRight" = 0.

    Parameters (1)
    • theRight
  • Add(theRight: math_VectorBase_int): void

    adds the vector "theRight" to a vector. An exception is raised if the vectors have not the same length. Warning In order to avoid time-consuming copying of vectors, it is preferable to use operator += or the function Add whenever possible.

    Parameters (1)
    • theRight
  • Add(theLeft: math_VectorBase_int, theRight: math_VectorBase_int): void

    sets a vector to the sum of the vector "theLeft" and the vector "theRight". An exception is raised if the lengths are different.

    Parameters (2)
    • theLeft
    • theRight
  • Added(theRight: math_VectorBase_int): math_VectorBase_int

    Returns new vector as adding current vector with the value "theRight". An exception is raised if the vectors do not have the same length. An exception is raised if the lengths are not equal.

    Parameters (1)
    • theRight
  • TMultiply(theTLeft: math_Matrix, theRight: math_VectorBase_int): void

    sets a vector to the product of the transpose of the matrix "theTLeft" by the vector "theRight".

    Parameters (2)
    • theTLeft
    • theRight
  • TMultiply(theLeft: math_VectorBase_int, theTRight: math_Matrix): void

    sets a vector to the product of the vector "theLeft" by the transpose of the matrix "theTRight".

    Parameters (2)
    • theLeft
    • theTRight
  • Subtract(theLeft: math_VectorBase_int, theRight: math_VectorBase_int): void

    sets a vector to the Subtraction of the vector theRight from the vector theLeft. An exception is raised if the vectors have not the same length. Warning In order to avoid time-consuming copying of vectors, it is preferable to use operator -= or the function Subtract whenever possible.

    Parameters (2)
    • theLeft
    • theRight
  • Subtract(theRight: math_VectorBase_int): void

    returns the subtraction of "theRight" from "me". An exception is raised if the vectors have not the same length.

    Parameters (1)
    • theRight
  • Value(theNum: number): number

    accesses the value of index "theNum" of a vector.

    Parameters (1)
    • theNum
  • Initialized(theOther: math_VectorBase_int): math_VectorBase_int

    Initialises a vector by copying "theOther". An exception is raised if the Lengths are different.

    Parameters (1)
    • theOther
  • Opposite(): math_VectorBase_int

    returns the opposite of a vector.

  • Subtracted(theRight: math_VectorBase_int): math_VectorBase_int

    returns the subtraction of "theRight" from "me". An exception is raised if the vectors have not the same length.

    Parameters (1)
    • theRight
  • Array1(): NCollection_Array1_int

    Returns the underlying array for interoperability with legacy APIs. Allows passing math_Vector data to functions expecting NCollection_Array1.

  • Resize(theSize: number): void

    Resizes the vector to a new size, keeping the same lower bound. Existing data within the new range is preserved. The method optimizes memory usage:

    • If new size fits in stack buffer (<=32), uses stack allocation
    • If new size requires heap and was already on heap, resizes in place
    • Transitions between stack and heap as needed
    Parameters (1)
    • theSize —
      new size of the vector