1.180.2 Send methods

vector ->clear:

Delete all elements, as well as the allocated array. After this operation, the vector has the same status as a vector just created from an empty argument list.

vector ->element: index=int, value=any

Set element N (1-based) to the specified value. N is outside the array, the array is automatically enlarged. The skipped elements are filled with @default.

vector ->fill: value=any, from=[int], to=[int]

Fill range of elements with the specified value. from and to default to vector<-low_index resp. vector<-high_index. This is a common way to create a vector with a specific range.

vector ->for_all: code=code, from=[int], to=[int]

Run's code on all elements of the vector. Fails if code fails for some element. Succeeds after all elements have been processed. Arguments:

@arg1	The current element
@arg2	Index of this element

Its behaviour is undefined if the size of the vector is changed by code.

Using the from and to arguments, the range as well as the order of visited elements can be reduced. Using only from, the vector is enumerated starting at the given index.. Using only to, the vector is enumerated from vector<-low_index to the given index. Using both from and to, the vector is enumerated in the given range. If to < from the enumeration is executed backwards.

See also vector->for_some, vector<-find and vector<-find_all.

vector ->for_some: code=code, from=[int], to=[int]

Run's code on all elements of the vector. Ignores the exit status of code and always succeeds. Arguments:

@arg1	The current element
@arg2	Index of this element

Its behaviour is undefined if the size of the vector is changed by code.

Using from and to, the range and order can be defined. See vector->for_all for details.

vector ->initialise: element=any ...

Create a vector from the initial arguments. The first argument is placed at index 1, the second at 2, etc.

Bugs: It would be useful to be able to create a vector with a specified low and high index. To create a vector [5...20] do:

new(V, vector),
send(V, fill, @nil, 5, 20).

vector ->shift: places=int

Shift the elements by <n> places. The freed places are filled with @nil:

?- new(V, vector(gnu, gnats)),
   send(V, shift, 1),
   object(V, Term).

Term = vector(@nil, gnu)

vector ->sort: compare=code, from=[int], to=[int]

Sort the elements in the vector. Argument passing is equivalent to chain->sort. From and To may be used to sort only part of the vector. From defaults to vector<-low_index, and To to vector<-high_index. If To <= From, vector->sort succeeds without any side-effects.

See also

chain->sort

vector ->unlink:

Unreferences the -elements. All elements that have no further references will be destroyed by PCE's incremental garbage collector.