|
VecIdPt1D Class Function Manual |
|
|
VecIdPt1D Class Function Manual |
Purpose
To get a value of an element at a particular point in a Vector. The return result is a IdPt1D object.
The first element index is 0, and the last one is n-1, where n is no of total elements.
Class
VecIdPt1D
Usage
{IdPt1D} ret = object({int} argm1)
argm1 = index number
Example:
|
->v = VecIdPt1D(5) ->v.pushback(IdPt1d(1,10)) ->v.pushback(IdPt1d(2,20)) ->v.pushback(IdPt1d(3,30)) ->v |
See also (class function)
init
Purpose
To increase the maximum size of the vector by a given number.
Class
VecIdPt1D
Usage
{void} object.EXTEND({int} argm1)
argm1 = number of elements wanted to extend
Example:
|
->v = VecIdPt1D(5) ->v.maxsize() ->v.maxsize() |
See also (class function)
maxsize, truncate
Purpose
To find in a vector object a particular value of element. This function only compares the ID number of points. It does not take into account values of x coordinates.
The return result is an index of the vector, if found, otherwise it returns -1.
Class
VecIdPt1D
Usage
{int} ret = object.FIND({IdPt1D} argm1)
argm1 = value of an element wanted to find
Example:
|
->print v |
See also (class function)
qfind
Purpose
To report the current ID of the vector.
Class
VecIdPt1D
Usage
{int} ret = object.ID()
Example:
|
->v = VecIdPt1D(5) ->v.id() |
See also (class function)
maxsize, truncate, extend
Purpose
To initialize a vector object.
Please be aware that once the vector is initialized, it is still empty. Only its maximum number of element in the vector is declared. Use function "pushback" to insert element into a vector.
Class
VecIdPt1D
Usage
{void} object.INIT({int} argm1)
argm1 = number of maximum elements in the vector
Example:
|
->v = VecIdPt1D() ->v.init(500) -> |
See also (class function)
pushback
Purpose
To read data from an ASCII file and stored in a VecIdPt1D object.
If file name extension is omitted, the function will add default extensions to the files. The default extension of an ASCII data file is ".txt".
Unless the path name is given in the file names, the function will search for the files in the current working directory, defined by command "set path".
It is important to make sure that the each line in the file has only 2 or 3 fields, the first is read as index ID, the second field is x coordinates (or height). The third field, if any, is standard deviation. All of them are separated by at least one blank, a white space, ASCII 32.
It is possible to have a comment line in the data file, by inserting a slash sign, "/", in front of a line. Comment lines will not be read by the function.
Class
VecIdPt1D
Usage
{void} object.LOAD({String} argm1)
argm1 = data filename (default extension is ".txt")
Example:
|
->v = VecIdPt1D() ->v.load("my_data") -> |
See also (class function)
save
Purpose
To search for a particular ID block number, then read a block of data out from an ASCII file and stored in a VecIdPt1D object.
If file name extension is omitted, the function will add default extensions to the files. The default extension of an ASCII data file is ".txt".
Unless the path name is given in the file names, the function will search for the files in the current working directory, defined by command "set path".
Each line in the data file can either has one field or two fields. If it has 2 fields, they are separated by at least one blank, a white space, ASCII 32, and the first one is read as row number, while the second one is column number. A line with one field is interpreted as an ID.
An example of data is:
|
By using this function "loadsch", it is possible to store separate sets of data in one file, and be able to extract a particular data set within that file. Each data set must have its own unique ID, for example 101, 102, 103 (see example above).
It is possible to have a comment line in the data file, by inserting a slash sign, "/", in front of a line. Comment lines will not be read by the function.
Class
VecIdPt1D
Usage
{void} object.LOADSCH({String} argm1)
argm1 = data filename (default extension is ".txt")
Example:
|
->v = VecIdPt1D() ->v.loadsch("my_data", 101) ->print v |
See also (class function)
load
Purpose
To convert to a Matrix object.
This function creates a Matrix of size n rows by 3 columns, where n is number of indices in the vector.
Class
VecIdPt1D
Usage
{Matrix} ret = object.MATRIX()
Example:
|
->print v ->print M
|
See also (class function)
Purpose
To compute the maximum value of x coordinates in the vector.
Class
VecIdPt1D
Usage
{double} ret = object.MAX()
Example:
|
->print v |
See also (class function)
min, mean
Purpose
To report the maximum size of the vector. This is the maximum number of elements that can be stored in the vector.
Class
VecIdPt1D
Usage
{int} ret = object.MAXSIZE()
Example:
|
->v = VecIdPt1D(5) ->v.maxsize() |
See also (class function)
size, truncate, extend
Purpose
To compute the mean value of x coordinates in the vector.
Class
VecIdPt1D
Usage
{double} ret = object.MEAN()
Example:
|
->print v |
See also (class function)
min, max
Purpose
To compute the minimum value of x coordinates in the vector.
Class
VecIdPt1D
Usage
{double} ret = object.MIN()
Example:
|
->print v |
See also (class function)
max, mean
Purpose
To insert an IdPt1D in a vector object. A new element will be insert at the last available index in the vector.
Suppose the vector has already 4 element in it, when a new element is inserted, the size is updated to 5 and the new element is stored at index number 4. The first element index is 0, and the last one is n-1, where n is no of total elements.
Class
VecIdPt1D
Usage
{void} object.PUSHBACK({IdPt1D} argm1)
argm1 = an 2D point with ID being inserted
Example:
|
->v = VecIdPt1D(5) ->v.pushback(IdPt1d(1,10)) ->v.pushback(IdPt1d(2,20)) ->v.pushback(IdPt1d(3,30)) ->v |
See also (class function)
init
Purpose
To find in a vector object a particular value of element. This function expects that the content of the vector is already sorted, or otherwise it will not work correctly.
This function only compares the ID number of the index. It does not take into account values of coordinates.
It performs a binary searching which is much faster than using the function "find".
The return result is an index of the vector, if found, otherwise it returns -1.
Class
VecIdPt1D
Usage
{int} ret = object.FIND({IdPt1D} argm1)
argm1 = value of an element wanted to find
Example:
|
->print v |
See also (class function)
find
Purpose
To empty the content of the vector.
This function can be used to reset the vector very quick. It simply sets the size of the vector to zero. It does not do any memory initialization.
Class
VecIdPt1D
Usage
{void} object.REMALL()
Example:
|
->print v ->print v -> |
See also (class function)
remove, remsort
Purpose
To remove an element at a particular index out of the vector.
This function replaces the content at the required index with the last element, and simply reduces the size of the vector by 1.
Class
VecIdPt1D
Usage
{void} object.REMOVE({int} argm1)
argm1 = index at which the element being removed
Example:
|
->print v ->print v |
See also (class function)
remall, remsort
Purpose
To remove a group of elements, specified by a starting index and ending index, out of the vector. This function will fill up the gap by shift the rest of the content of the vector forward.
Class
VecIdPt1D
Usage
{void} object.REMSORT({int} argm1,[{int} argm1])
argm1 = start index at which the element being removed
argm2 = ending index at which the element being removed
(default = the same index as the start index)
Example:
|
->print v ->print v |
See also (class function)
remall, remove
Purpose
To save as ASCII format. Each line in the output file represents an element in the vector.
if a file name extension is not given, the function assumes an extension of ".txt".
if a path name is not include in the specified file name, the function will search in the current data path, set by command "set path".
Class
VecIdPt1D
Usage
{void} object.SAVE({String} argm1)
argm1 = output file name
Example:
|
->v.save("my_data") |
See also (class function)
load, loadsch
Purpose
To value of standard deviation of all elements in a vector.
Class
VecIdPt1D
Usage
{void} object.SET_SD({double} argm1)
argm1 = value of standard deviation being set
Example:
|
->print v ->print v |
See also (class function)
Purpose
To shift the whole vector of by a constant.
Class
VecIdPt1D
Usage
{void} object.SHIFT({double} argm1)
argm1 = shift applied to coordinate
Example:
|
->v = VecIdPt1D(5) ->v.pushback(IdPt1D(1,10)) ->v.pushback(IdPt1D(2,20)) ->v.pushback(IdPt1D(3,30)) ->print v ->print v |
See also (class function)
Purpose
To report the current size of the vector. This is the current number of elements in the vector.
Class
VecIdPt1D
Usage
{int} ret = object.SIZE()
Example:
|
->v = VecIdPt1D(5) ->v.size() |
See also (class function)
maxsize, truncate, extend
Purpose
To sort elements of a vector by using Shell sort.
Elements in a vector are sorted by their ID numbers.
Class
VecIdPt1D
Usage
{VecIdPt1D} ret = object.SORT()
Example:
|
->print v ->print v1 |
See also (class function)
qfind
Purpose
To sort elements of a vector by using Shell sort.
Elements in a vector are sorted by their x coordinates.
Class
VecIdPt1D
Usage
{VecIdPt1D} ret = object.SORT_X()
Example:
|
->print v ->print v1 |
See also (class function)
sort
Purpose
To trim out all the empty space of the current vector.
Suppose a vector has 5 elements in it, and its max size is 500, once it is trimmed, the max size is reduced to 5. This function does a new memory initialization.
Class
VecIdPt1D
Usage
{void} object.TRUNCATE()
argm1 = number of elements wanted to extend
Example:
|
->v = VecIdPt1D(5) ->v.maxsize() ->v.maxsize() |
See also (class function)
maxsize, extend
Purpose
To extract a portion of a vector, specified by a starting index and ending index.
Class
VecIdPt1D
Usage
{VecIdPt1D} ret = object.WINDOW({int} argm1,{int} argm2)
argm1 = start index at which the element being extracted
argm2 = ending index at which the element being extracted
Example:
|
->print v ->print v1 |
See also (class function)
window_x
Purpose
To extract indices that fall within a window range, specified by the starting and ending x coordinates.
Class
VecIdPt1D
Usage
{VecIdIndx} ret = object.WINDOW_X({double} argm1,{double} argm2)
argm1 = start x coordinate of the window
argm2 = end x coordinate of the window
Example:
|
->print v ->print v1 |
See also (class function)
window