Vector Class Function Manual

(   )

| HOME | BACK |

Purpose

To get a value of an element at a particular index in a Vector. 

The first element index is 0, and the last one is n-1, where n is no of total elements.

Class

Vector

Usage

{double} ret  =  object({int} argm1)

argm1 = index number

Example:

->v = Vector(5)

->v.pushback(2)

->v.pushback(3)

->v.pushback(43)

->print v

Vector size : 3

2.00000
3.00000
43.00000

->v(0)

  ans = 2.00000

->

See also (class function)

init

| HOME | BACK |


EXTEND

| HOME | BACK |

Purpose

To increase the maximum size of the vector by a given number.

Class

Vector

Usage

{void} object.EXTEND({int} argm1)

argm1 = number of elements wanted to extend

Example:

->v = Vector(5)

->v.maxsize()

  ans = 5

->v.extend(500)

->v.maxsize()

  ans = 505

->

See also (class function)

maxsize, truncate

| HOME | BACK |


FIND

| HOME | BACK |

Purpose

To find in a vector object a particular value of element.

The return result is an index of the vector, if found, otherwise it returns -1.

Class

Vector

Usage

{int} ret  =  object.FIND({double} argm1)

argm1 = value of an element wanted to find

Example:

->v = Vector(5)

->v.pushback(100)

->v.pushback(200)

->v.pushback(300)

->v.pushback(400)

->print v

Vector size : 4

100.00000
200.00000
300.00000
400.00000

->v.find(300)

  ans = 2

->

See also (class function)

qfind

| HOME | BACK |


HSORT

| HOME | BACK |

Purpose

To sort elements of a vector by using Heap sort.

Class

Vector

Usage

{Vector} ret  =  object.HSORT()

Example:

->v = Vector(5)

->v.pushback(400)

->v.pushback(300)

->v.pushback(200)

->print v

Vector size : 3

400.00000
300.00000
200.00000

->v1 = v.hsort()

->print v1

Vector size : 3

200.00000
300.00000
400.00000

->

See also (class function)

sort

| HOME | BACK |


INIT

| HOME | BACK |

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

Vector

Usage

{void} object.INIT({int} argm1)

argm1 = number of maximum elements in the vector

Example:

->v = Vector()

->v.init(500)

->

See also (class function)

lingen

| HOME | BACK |


INT

| HOME | BACK |

Purpose

To convert to a vector of integer, a Vecint object.

Class

Vector

Usage

{Vecint} ret  =  object.INT()

Example:

->v = Vector(5)

->v.pushback(400)

->v.pushback(300)

->v.pushback(200)

->print v

Vector size : 3

400.00000
300.00000
200.00000

->v1 = v.int()

->print v1

Vector size : 3

400
300
200

->

See also (class function)

matrix

| HOME | BACK |


LAST

| HOME | BACK |

Purpose

To get the last element of the vector.

Class

Vector

Usage

{double} ret  =  object.LAST()

Example:

->v = Vector(5)

->v.pushback(400)

->v.pushback(300)

->v.pushback(200)

->print v

Vector size : 3

400.00000
300.00000
200.00000

->v.last()

  ans = 200.00000

->

See also (class function)

unstack

| HOME | BACK |


LINGEN

| HOME | BACK |

Purpose

To generate a vector whose first and last element values are specified by the user.  The values of elements in between will linearly increase by a specified interval.

Class

Vector

Usage

{void} object.LINGEN({double} argm1, {double} argm2, [{double} argm3])

argm1 = start value for the first element

argm2 = end value for the last element

argm3 = linear spacing interval         (default = 1)

Example:

->v = Vector()

->v.lingen(10,12)

->print v

Vector size : 3

10.00000
11.00000
12.00000

->v = Vector()

->v.lingen(20,15,-1)

->print v

Vector size : 6

20.00000
19.00000
18.00000
17.00000
16.00000
15.00000

->

See also (class function)

init, pushback

| HOME | BACK |


LOAD

| HOME | BACK |

Purpose

To read data from an ASCII file and stored in a Vector 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".

An example of an ASCII data file is as follows.

10

45e3

7.895

Here the data file has 3 lines.  This will generate a vector of 3 elements.

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

Vector

Usage

{void} object.LOAD({String} argm1)

argm1 = data filename (default extension is ".txt")

Example:

->v = Vector()

->v.load("my_data")

->

See also (class function)

init, pushback

| HOME | BACK |


MATRIX

| HOME | BACK |

Purpose

To convert to a Matrix object. 

This function creates a Matrix of size n row by 1 column, where n is number of elements in the vector.

Class

Vector

Usage

{Matrix} ret  =  object.MATRIX()

Example:

->v = vector()

->v.lingen(10,14)

->print v

Vector size : 5

10.00000
11.00000
12.00000
13.00000
14.00000

->M = v.matrix()

->print M

 no of row    : 5
 no of column : 1

 0:   10.00000
 1:   11.00000
 2:   12.00000
 3:   13.00000
 4:   14.00000

->

See also (class function)

int

| HOME | BACK |


MAX

| HOME | BACK |

Purpose

To compute the maximum value of elements in the vector.

Class

Vector

Usage

{double} ret  =  object.MAX()

Example:

->v = Vector(5)

->v.pushback(400)

->v.pushback(300)

->v.pushback(200)

->v.max()

  ans = 400.00000

->

See also (class function)

min, median

| HOME | BACK |


MAXSIZE

| HOME | BACK |

Purpose

To report the maximum size of the vector.  This is the maximum number of elements that can be stored in the vector.

Class

Vector

Usage

{int} ret  =  object.MAXSIZE()

Example:

->v = Vector(5)

->v.maxsize()

  ans =   5

->

See also (class function)

size, truncate, extend

| HOME | BACK |


MEDIAN

| HOME | BACK |

Purpose

To determine a median, a value at the center position when all elements are sorted, of a Vector object.

Class

Vector

Usage

{double} ret  =  object.MEDIAN()

Example:

->v = Vector(5)

->v.pushback(400)

->v.pushback(300)

->v.pushback(200)

->v.median()

  ans = 300.00000

->

See also (class function)

min, max

| HOME | BACK |


MIN

| HOME | BACK |

Purpose

To compute the minimum value of elements in the vector.

Class

Vector

Usage

{double} ret  =  object.MIN()

Example:

->v = Vector(5)

->v.pushback(400)

->v.pushback(300)

->v.pushback(200)

->v.max()

  ans = 200.00000

->

See also (class function)

max, median

| HOME | BACK |


MPUSHBACK

| HOME | BACK |

Purpose

To insert multiple elements in a vector object.  New elements will be appended to the calling vector.

Class

Vector

Usage

{void} object.MPUSHBACK({double} argm1,{int} argm2)

argm1 = value of an element being inserted

argm2 = no of repetition

Example:

->v = Vector(5)

->v.pushback(100, 4)

->print v

Vector size : 4

100.00000
100.00000
100.00000
100.00000

->

See also (class function)

pushback

| HOME | BACK |


PUSHBACK

| HOME | BACK |

Purpose

To insert an element 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

Vector

Usage

{void} object.PUSHBACK({double} argm1)

argm1 = value of an element being inserted

Example:

->v = Vector(5)

->v.pushback(100)

->v.pushback(200)

->v.pushback(300)

->v.pushback(400)

->print v

Vector size : 4

100.00000
200.00000
300.00000
400.00000

->

See also (class function)

init

| HOME | BACK |


QFIND

| HOME | BACK |

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.

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

Vector

Usage

{int} ret  =  object.FIND({double} argm1)

argm1 = value of an element wanted to find

Example:

->v = Vector(5)

->v.pushback(100)

->v.pushback(200)

->v.pushback(300)

->v.pushback(400)

->print v

Vector size : 4

100.00000
200.00000
300.00000
400.00000

->v.qfind(300)

  ans = 2

->

See also (class function)

find

| HOME | BACK |


REMALL

| HOME | BACK |

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

Vector

Usage

{void} object.REMALL()

Example:

->v = Vector(5)

->v.pushback(100)

->v.pushback(200)

->v.pushback(300)

->v.pushback(400)

->v.remall()

->print v

->

See also (class function)

remove, remsort

| HOME | BACK |


REMOVE

| HOME | BACK |

Purpose

To remove an element at a particular index out of the vector.

This function replace the content at the required index with the last element, and simply reduces the size of the vector by 1.

Class

Vector

Usage

{void} object.REMOVE({int} argm1)

argm1 = index at which the element being removed

Example:

->v = vector()

->v.lingen(100,400,100)

->print v

Vector size : 4

100.00000
200.00000
300.00000
400.00000

->v.remove(1)

->print v

Vector size : 3

100.00000
400.00000
300.00000

->

See also (class function)

remall, remsort

| HOME | BACK |


REMSORT

| HOME | BACK |

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

Vector

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:

->v = vector()

->v.lingen(1,20,2)

->print v

Vector size : 10

1.00000
3.00000
5.00000
7.00000
9.00000
11.00000
13.00000
15.00000
17.00000
19.00000

->v.remsort(3,6)

->print v

Vector size : 6

1.00000
3.00000
5.00000
15.00000
17.00000
19.00000

->

See also (class function)

remall, remove

| HOME | BACK |


REVERSE

| HOME | BACK |

Purpose

To reverse the content of the vector.

Class

Vector

Usage

{Vector} ret  =  object.REVERSE()

Example:

->v = vector()

->v.lingen(1,20,2)

->print v

Vector size : 10

1.00000
3.00000
5.00000
7.00000
9.00000
11.00000
13.00000
15.00000
17.00000
19.00000

->v1 = v.reverse()

->print v1

Vector size : 10

19.00000
17.00000
15.00000
13.00000
11.00000
9.00000
7.00000
5.00000
3.00000
1.00000

->

See also (class function)

sort, qsort

| HOME | BACK |


SAVE

| HOME | BACK |

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

Vector

Usage

{void} object.SAVE({String} argm1, [{int} argm2])

argm1 = output file name

argm2 = no of decimal digits (default = value set by command "set precision")

Example:

->v.save("my_data")

->

See also (class function)

load

| HOME | BACK |


SIZE

| HOME | BACK |

Purpose

To report the current size of the vector.  This is the current number of elements in the vector.

Class

Vector

Usage

{int} ret  =  object.SIZE()

Example:

->v = Vector(5)

->v.size()

  ans =   0

->

See also (class function)

maxsize, truncate, extend

| HOME | BACK |


SORT

| HOME | BACK |

Purpose

To sort elements of a vector by using Shell sort.

Class

Vector

Usage

{Vector} ret  =  object.SORT()

Example:

->v = Vector(5)

->v.pushback(400)

->v.pushback(300)

->v.pushback(200)

->print v

Vector size : 3

400.00000
300.00000
200.00000

->v1 = v.sort()

->print v1

Vector size : 3

200.00000
300.00000
400.00000

->

See also (class function)

hsort

| HOME | BACK |


TRUNCATE

| HOME | BACK |

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

Vector

Usage

{void} object.TRUNCATE()

argm1 = number of elements wanted to extend

Example:

->v = Vector(5)

->v.maxsize()

  ans = 5

->v.truncate()

->v.maxsize()

  ans = 0

->

See also (class function)

maxsize, extend

| HOME | BACK |


UNSTACK

| HOME | BACK |

Purpose

To get and take it out the last element of the vector.

This function is similar to function "last", however, it reduces the size of the vector by 1.

Class

Vector

Usage

{double} ret  =  object.UNSTACK()

Example:

->v = vector()

->v.lingen(1,8)

->print v

Vector size : 8

1.00000
2.00000
3.00000
4.00000
5.00000
6.00000
7.00000
8.00000

->x = v.unstack()

->print x

8.00000

->print v

Vector size : 7

1.00000
2.00000
3.00000
4.00000
5.00000
6.00000
7.00000

->

See also (class function)

last

| HOME | BACK |


WINDOW

| HOME | BACK |

Purpose

To extract a portion of a vector, specified by a starting index and ending index.

Class

Vector

Usage

{Vector} 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:

->v = vector()

->v.lingen(1,8)

->print v

Vector size : 8

1.00000
2.00000
3.00000
4.00000
5.00000
6.00000
7.00000
8.00000

->v1 = v.window(1,3)

->print v1

Vector size : 3

2.00000
3.00000
4.00000

->

See also (class function)

 

| HOME | BACK |