Command: arraylib::Reform

NEST HelpDesk Command Index NEST Quick Reference

Name:
 arraylib::Reform - Reform the dimensions of a hyperrectengular array

Synopsis:
 [array] [dim1 dim2 ... dimn] Reform -> [reformedArray]

Description:
"Reform" changes the dimensionality i.e. the nesting of an array. The
result is a hyperrectangular array of the given dimensions. The order
of elements is not changed.

"Reform" relates to "Dimensions" in the following way:
Given a hyperrectangular array [a] of "Dimensions" [d], these
statements are true:

a           d Reform -> a
a Flatten   d Reform -> a
a dv Reform d Reform -> a, for any valid dimension vector [dv]

Diagnostics:
If the new dimensionality is not consistent with the numer of elements
in the array, /RangeCheck is raised.

Availability:
"Namespace"-dictionary "arraylib".

Author:
 Ruediger Kupper

FirstVersion:
 10.3.2003

Remarks:
The new dimensionality must not change the number of elements in the
whole array, that is, dim1*...*dimn must equal the number of the
flattened source array.

References:
This routine is inspired by IDL's REFORM() routine.

SeeAlso:Dimensions TensorRank Flatten
Source:
 /home/abuild/rpmbuild/BUILD/nest-2.4.1/lib/sli/arraylib.sli

NEST HelpDesk Command Index NEST Quick Reference

© 2000-2010 The NEST Initiative