local array(+Array, +Type)

+Array

Ground compound term with integer arguments.

+Type

One of the atoms: float, integer, byte, prolog

Description

The array indexes in the array range from 0 to the dimension minus one. For example myarray create with local array(myarray(3,4,5), integer) contains 60 integers that may be accessed from myarray(0,0,0) to myarray(2,3,4).

The contents of the array persists across failures. The value of the array elements can be changed with setval/2 and retrieved with getval/2. Setting and retrieving terms from a non-logical arrays involves copying the term each time. In particular, if the term contains variables, they lose their identity and are replaced with fresh ones.

Notes:

Re-declaring an existing array with the same dimension but different sizes or type raises a warning.

It is possible to create arrays with global visibility using global arrays(A) but this feature will be removed in future releases.

Fail Conditions

Resatisfiable

Exceptions

(4) instantiation fault

Array or Type is not ground.

(5) type error

Array is not a structure with integer arguments.

(5) type error

Type is not an atom.

(6) out of range

Type is not a valid type name.

(6) out of range

The ground structure Array has arguments that are integers not greater than 0.

(24) number expected

The ground structure Array has arguments that are non-numbers.

(42) redefining an existing array

An array with the same name and dimension as Array already exists.

Examples

Success:
      local array(a(4), prolog).
      local array(b(2,3), integer).
      local array(a(4), float), array(a(4,1), byte).

Error:
      local array(X, prolog).                         (Error 4).
      local array(a(6.0), integer).                   (Error 5).
      local array(a(0), integer).                     (Error 6).
      local array(a(-2), integer).                    (Error 6).
      local array(a(4), integer), array(a(5), float).  (Warning 42).

See Also