The SDL Component Suite is an industry leading collection of components supporting scientific and engineering computing. Please visit the SDL Web site for more information....


Home MathPack Vector Methods MakeValidElemRange
See also: NrOfElem 

MakeValidElemRange

Unit:SDL_vector
Class: TVector, TIntVector
Declaration: function MakeValidElemRange (var LowElem, HighElem: integer): integer;

The method MakeValidElemRange ensures that the vector indexes LowElem and HighElem are within the valid index range of the vector (i.e. they are greater or equal to 1 and less than or equal to NrOfElem). If any of the two variable parameters falls outside the valid range, it is adjusted to the nearest limit. Passing a zero value to both parameters returns the minimum and maximum range values (i.e. 1 and NrOfElem).

The function returns the following codes:

 0 ... both LowElem and HighElem are within the valid range, no adjustments made
-1 ... LowElem and/or HighElem have been adjusted because they were outside the valid range


Last Update: 2023-Feb-06