array-utils

API Reference

array-utils

A few utilities for working with arrays.

ARRAY-UTILS

  • Function ENSURE-ARRAY-SIZE (array new-space)
  • Function ARRAY-SHIFT (array &key (n 1) (from 0) to (adjust t) (fill nil f-p) (contents nil c-p))
    Shifts a subset of array elements in either direction for a specified amount. Optionally also extends the array and fills empty space with a given element. N --- The amount to be moved. If positive, things are shifted to the right. If negative, things are shifted to the left. FROM --- The left point of the region to move, inclusive. TO --- The right point of the region to move, exclusive. ADJUST --- Whether to adjust the fill pointer and the array bounds. The array is only adjusted if N is positive and the range of TO+N would exceed the ARRAY length, or if N is negative and TO equals the length of the ARRAY FILL --- If provided, empty spaces created by the move will be filled with this element. CONTENTS --- If provided, uses the contents to fill the new space. If |N| is greater than the length of this sequence, FILL is used to fill the rest of the space if it is provided. If not, an error is signalled. No matter whether N is negative or positive, the content is filled in from left to right in the order it is given.
  • Function VECTOR-PUSH-EXTEND-POSITION (element vector position)
    Pushes the element into the specified position and shifts everything to the right to make space. This is potentially very costly as all elements after the given position need to be shifted as per ARRAY-SHIFT.
  • Function VECTOR-PUSH-EXTEND-FRONT (element vector)
    Pushes the element onto the front of the vector and extends if necessary. This operation is very costly and takes O(n) time as each element needs to be shifted as per ARRAY-SHIFT. See VECTOR-PUSH-EXTEND-POSITION
  • Function VECTOR-POP-POSITION (vector position)
    Pops the element at the given position of the vector and returns it. This is potentially very costly as all elements after the given position need to be shifted back as per ARRAY-SHIFT.
  • Function VECTOR-POP-FRONT (vector)
    Pops the first element off the vector and returns it. This operation is very costly and takes O(n) time as each element needs to be shifted as per ARRAY-SHIFT. See VECTOR-POP-POSITION
  • Function VECTOR-APPEND (vector sequence &optional position)
    Appends all elements of the sequence at position of the vector and returns it. This is potentially very costly as all elements after the given position need to be shifted back as per ARRAY-SHIFT.