All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

AdvancedMathematics Class CATMathSetOfPointsNDTwoTangents

Mathematics.CATCGMVirtual
  |
  +---AdvancedMathematics.CATMathSetOfPointsND
    |
    +---CATMathSetOfPointsNDTwoTangents
 

Usage: you must use this class as is. You should never derive it.


public class CATMathSetOfPointsNDTwoTangents

Class defining a set of points in R^n with two extremal tangents.


Constructor and Destructor Index


o CATMathSetOfPointsNDTwoTangents(CATLONG32,CATLONG32)
Constructs a CATMathSetOfPointsNDTwoTangents.
o CATMathSetOfPointsNDTwoTangents(CATLONG32,CATLONG32,CATLONG32)
o CATMathSetOfPointsNDTwoTangents(CATLONG32,CATLONG32,double*)
Constructs a CATMathSetOfPointsNDTwoTangents.
o CATMathSetOfPointsNDTwoTangents(CATLONG32,CATLONG32,double*,double*)
Constructs a CATMathSetOfPointsNDTwoTangents.
o CATMathSetOfPointsNDTwoTangents(CATMathSetOfPointsNDTwoTangents&)
Copy constructor.
o ~CATMathSetOfPointsNDTwoTangents()
Destructor.

Method Index


o AddSet(CATMathSetOfPointsNDTwoTangents&,CATBoolean)
Concatenates a CATMathSetOfPointsNDTwoTangents just after the last point of this CATMathSetOfPointsNDTwoTangents.
o AutoInvert()
Inverts the content of this CATMathSetOfPointsNDTwoTangents inside itself.
o ComputeTangents(double*,double*)
Computes the tangent in each point of this CATMathSetOfPointsND.
o FindCircle(CATLONG32*,double&,double*,double*,double*,double,double,CATTolerance&)
Searches for a 3D circle defined by the set of points on 3 specific coordinates.
o GetFirstTangent()
Returns the first tangent of this CATMathSetOfPointsNDTwoTangents.
o GetLastTangent()
Returns the last tangent of this CATMathSetOfPointsNDTwoTangents.
o Invert(CATMathSetOfPointsNDTwoTangents&)
Inverts the content of this CATMathSetOfPointsNDTwoTangents.
o IsA()
Returns the class name .
o IsAKindOf(CATMathClassId)
Tests the class of this CATMathSetOfPointsNDTwoTangents.
o IsLinear(CATLONG32,CATLONG32*,CATTolerance&)
Searches for a line defined by the set of points on specific coordinates.
o RemovePoint(CATLONG32)
Removes one point of this CATMathSetOfPointsNDTwoTangents.
o RemovePoints(CATMathSetOfLongs&)
Removes points of this CATMathSetOfPointsNDTwoTangents.
o Reset()
Resets this CATMathSetOfPointsTwoTangents (the points and the tangents).
o SetFirstTangent(double*)
Modifies the first tangent of this CATMathSetOfPointsNDTwoTangents.
o SetLastTangent(double*)
Modifies the last tangent of this CATMathSetOfPointsNDTwoTangents.
o SetPeriodic(CATBoolean)
Sets the periodicity of this CATMathSetOfPointsNDTwoTangents.
o Split(CATLONG32,CATMathSetOfPointsNDTwoTangents&,CATBoolean,CATTolerance&)
Splits a CATMathSetOfPointsNDTwoTangents just after the point corresponding to the iIndex.
o operator =(CATMathSetOfPointsNDTwoTangents&)
Assignment operator.

Constructor and Destructor


o CATMathSetOfPointsNDTwoTangents
public CATMathSetOfPointsNDTwoTangents( const CATLONG32 iN,
const CATLONG32 iNumberOfPoint)
Constructs a CATMathSetOfPointsNDTwoTangents.
The tangents are initialized by the null vector.
Parameters:
iN
The dimension of the space.
iNumberOfPoint
The size of the set.
o CATMathSetOfPointsNDTwoTangents
public CATMathSetOfPointsNDTwoTangents( const CATLONG32 N,
const CATLONG32 NbOfPoint,
const CATLONG32 NbOfTangent)
o CATMathSetOfPointsNDTwoTangents
public CATMathSetOfPointsNDTwoTangents( const CATLONG32 iN,
const CATLONG32 iNumberOfPoint,
const double* iTangent)
Constructs a CATMathSetOfPointsNDTwoTangents.
Parameters:
iN
The dimension of the space.
iNumberOfPoint
The size of the set.
iTangent
The array [2*N] of the coordinates of the two tangents, one after the other.
o CATMathSetOfPointsNDTwoTangents
public CATMathSetOfPointsNDTwoTangents( const CATLONG32 iN,
const CATLONG32 iNumberOfPoint,
const double* iTangent0,
const double* iTangent1)
Constructs a CATMathSetOfPointsNDTwoTangents.
Parameters:
iN
The dimension of the space.
iNumberOfPoint
The size of the set.
iTangent0
The array [N] of the coordinates of the first tangente.
iTangent1
The array [N] of the coordinates of the second tangente.
o CATMathSetOfPointsNDTwoTangents
public CATMathSetOfPointsNDTwoTangents( const CATMathSetOfPointsNDTwoTangents& iToCopy)
Copy constructor.
o ~CATMathSetOfPointsNDTwoTangents
public virtual ~CATMathSetOfPointsNDTwoTangents()
Destructor.

Methods


o AddSet
public void AddSet( const CATMathSetOfPointsNDTwoTangents& iSetToConcatenate,
CATBoolean iMerge)
Concatenates a CATMathSetOfPointsNDTwoTangents just after the last point of this CATMathSetOfPointsNDTwoTangents. If needed, this CATMathSetOfPointsNDTwoTangents is reallocated.
Parameters:
iSetToConcatenate
The set to concatenate.
iMerge
The way to concatenate.
Legal values: TRUE if the last point of this CATMathSetOfPointsNDTwoTangents. and the first point of iSetToConcatenate must be merged, FALSE otherwise.
o AutoInvert
public void AutoInvert()
Inverts the content of this CATMathSetOfPointsNDTwoTangents inside itself.
The tangents are also inverted.
o ComputeTangents
public void ComputeTangents( const double* iParameters,
double* ioTangents) const
Computes the tangent in each point of this CATMathSetOfPointsND.
Parameters:
iParameters
The distance of each successive interval. To be filled by the CATMathSetOfPointsND::InitializeParameters method.
ioTangents
The array of the tangents. Must be previously allocated to NumberOfPoints.
o FindCircle
public virtual CATLONG32 FindCircle( const CATLONG32* iCoordIndex,
double& ioRadius,
double* ioCenter,
double* ioU,
double* ioV,
double iTol=0.,
double iPlanarityTol= 0.,
const CATTolerance& iTolObject=CATGetDefaultTolerance())const
Searches for a 3D circle defined by the set of points on 3 specific coordinates.
Parameters:
iCoordIndex
The array of 3 coodinates indexes to be taken into account, such that 0 <= iCoord[i] < N, i=0,1,2.
ioRadius
The value of the radius of the circle.
ioCenter
The 3D center point.
ioU
The first normed vector of the circle plane.
ioV
The second orthonormed vector of the circle plane.
iTol
The tolerance to match the circle. By default, the numerical tolerance is used.
iPlanarityTol
The tolerance to match the circle plane. By default, the numerical tolerance is used.
iTolObject
The default tolerance.
Returns:
The result diagnosis. 1 if a circle has been found, 0 otherwise.
o GetFirstTangent
public const double * GetFirstTangent()const
Returns the first tangent of this CATMathSetOfPointsNDTwoTangents.
Returns:
The array [N] of coordinates. Must be previously allocated.
o GetLastTangent
public virtual const double * GetLastTangent()const
Returns the last tangent of this CATMathSetOfPointsNDTwoTangents.
Returns:
The array [N] of coordinates. Must be previously allocated.
o Invert
public void Invert(CATMathSetOfPointsNDTwoTangents& ioResultingSet) const
Inverts the content of this CATMathSetOfPointsNDTwoTangents.
Parameters:
ioResultingSet
The result of the inversion (must be previously allocated). The tangents are also inverted.
o IsA
public CATMathClassId IsA()const
Returns the class name .
Returns:
CATMathSetOfPointsNDTwoTangents.
o IsAKindOf
public CATBoolean IsAKindOf( const CATMathClassId iClassId) const
Tests the class of this CATMathSetOfPointsNDTwoTangents.
Parameters:
iClassId
The name of the class.
Returns:
The result of the test.
Legal values: TRUE if this CATMathSetOfPointsNDTwoTangents is a kind of iClassId, FALSE otherwise.
o IsLinear
public virtual CATLONG32 IsLinear( const CATLONG32 iNumCoord,
const CATLONG32* iCoordIndex,
const CATTolerance& iTolObject=CATGetDefaultTolerance())const
Searches for a line defined by the set of points on specific coordinates.
Parameters:
iNumCoord
The number of coordinates to take into account.
iCoordIndex
The array of iNumCoord coodinates indexes to be taken into account, such that 0 <= iCoord[i] < N, i=0,..,iNumCoord-1.
iTolObject
The default tolerance.
Returns:
The result diagnosis. 1 if a line has been found, 0 otherwise.
o RemovePoint
public void RemovePoint( const CATLONG32 iIndexToRemove)
Removes one point of this CATMathSetOfPointsNDTwoTangents.
The points after the removed point are shift, but the memory is not deleted (_MaxNumberOfPoint still remains the same).
Parameters:
iIndexToRemove
The index of the point to remove 0<= iIndexToRemove < NumberOfPoints .
o RemovePoints
public void RemovePoints( const CATMathSetOfLongs& iPointsIndex)
Removes points of this CATMathSetOfPointsNDTwoTangents.
The remaining points are shift, but the memory is not deleted (_MaxNumberOfPoint still remains the same).
Parameters:
iPointsIndex
The list of the indexes of the points to remove.
o Reset
public virtual void Reset()
Resets this CATMathSetOfPointsTwoTangents (the points and the tangents).
The memory is not deleted and the class can be used again.
o SetFirstTangent
public void SetFirstTangent( const double* iA)
Modifies the first tangent of this CATMathSetOfPointsNDTwoTangents.
Parameters:
iA
The array [N] of coordinates.
o SetLastTangent
public virtual void SetLastTangent( const double* iB)
Modifies the last tangent of this CATMathSetOfPointsNDTwoTangents.
Parameters:
iB
The array [N] of coordinates.
o SetPeriodic
public void SetPeriodic( const CATBoolean iPeriodic= 1)
Sets the periodicity of this CATMathSetOfPointsNDTwoTangents.
Parameters:
iPeriodic

Legal values :
1
Sets to periodic: in this case, the first and the last points must be the same.
0
unsets the periodicity.
o Split
public virtual void Split( const CATLONG32 iIndex,
CATMathSetOfPointsNDTwoTangents& ioSetbis,
CATBoolean iMerge,
const CATTolerance& iTolObject=CATGetDefaultTolerance())
Splits a CATMathSetOfPointsNDTwoTangents just after the point corresponding to the iIndex. The part of this CATMathSetOfPointsNDTwoTangents before iIndex will stay in this CATMathSetOfPointsNDTwoTangents, and the part after will go in ioSetbis. If needed, ioSetbis is reallocated,and this CATMathSetOfPointsNDTwoTangents is disallocated.
Parameters:
iIndex
The index of the point where to split(0<=iIndex
iSetbis
The new set after the split(must be previously allocated).
iMerge
The way to split.
Legal values: TRUE if the last point of new this CATMathSetOfPointsNDTwoTangents. and the first point of iSetbis will be the same equal to iIndex point, FALSE if the last . point of new this CATMathSetOfPointsNDTwoTangents will be equal to iIndex point and the first point. of iSetbis will be the iIndex+1 point.
iTolObject
The default tolerance.
o operator =
public CATMathSetOfPointsNDTwoTangents & operator =( const CATMathSetOfPointsNDTwoTangents& iS)
Assignment operator.

This object is included in the file: CATMathSetOfPointsNDTwoTangents.h
If needed, your Imakefile.mk should include the module: CATAdvancedMathematics

Copyright © 2003, Dassault Systèmes. All rights reserved.