Liking cljdoc? Tell your friends :D

tupelo.array.mutable


Arrayclj

Plumatic Schema type definition for a 2-D array of values (a vector of vectors).

Plumatic Schema type definition for a 2-D array of values (a vector of vectors).
sourceraw docstring

array->col-valsclj

(array->col-vals arr)

Inputs: [arr :- Array] Returns: tsk/Vec

Returns the concatenation of all array cols.

Inputs: [arr :- Array]
Returns: tsk/Vec

Returns the concatenation of all array cols.
sourceraw docstring

array->colsclj

(array->cols arr)
(array->cols arr col-idxs)
(array->cols arr low high)

Inputs: ([arr] [arr col-idxs :- [s/Int]] [arr :- Array low :- s/Int high :- s/Int]) Returns: [[s/Any]]

Usage: (array->cols arr) Returns all array cols (array->cols arr col-idxs) Returns array cols specified by col-idxs (array->cols arr low high) Returns array cols in half-open interval [low..high)

Inputs: ([arr] [arr col-idxs :- [s/Int]] [arr :- Array low :- s/Int high :- s/Int])
Returns: [[s/Any]]

Usage:
        (array->cols arr)           Returns all array cols
        (array->cols arr col-idxs)  Returns array cols specified by col-idxs
        (array->cols arr low high)  Returns array cols in half-open interval [low..high) 
sourceraw docstring

array->ednclj

(array->edn arr)

Inputs: [arr :- Array] Returns: [[s/Any]]

Returns a persistant EDN data structure (vector-of-vectors) from the array.

Inputs: [arr :- Array]
Returns: [[s/Any]]

Returns a persistant EDN data structure (vector-of-vectors) from the array.
sourceraw docstring

array->row-valsclj

(array->row-vals arr)

Inputs: [arr :- Array] Returns: tsk/Vec

Returns the concatenation of all array rows.

Inputs: [arr :- Array]
Returns: tsk/Vec

Returns the concatenation of all array rows.
sourceraw docstring

array->rowsclj

(array->rows arr)
(array->rows arr row-idxs)
(array->rows arr low high)

Inputs: ([arr] [arr row-idxs :- [s/Int]] [arr :- Array low :- s/Int high :- s/Int]) Returns: [[s/Any]]

Usage: (array->rows arr) Returns all array rows (array->rows arr row-idxs) Returns array rows specified by row-idxs (array->rows arr low high) Returns array rows in half-open interval [low..high)

Inputs: ([arr] [arr row-idxs :- [s/Int]] [arr :- Array low :- s/Int high :- s/Int])
Returns: [[s/Any]]

Usage:
        (array->rows arr)           Returns all array rows
        (array->rows arr row-idxs)  Returns array rows specified by row-idxs
        (array->rows arr low high)  Returns array rows in half-open interval [low..high) 
sourceraw docstring

array->strclj

(array->str arr)

Inputs: [arr :- Array] Returns: s/Str

Returns a string representation of an array

Inputs: [arr :- Array]
Returns: s/Str

Returns a string representation of an array
sourceraw docstring

col-dropclj

(col-drop orig & idxs-drop)

Inputs: [orig :- Array & idxs-drop :- [s/Int]] Returns: Array

Drop one or more cols from an array

Inputs: [orig :- Array & idxs-drop :- [s/Int]]
Returns: Array

Drop one or more cols from an array
sourceraw docstring

col-getclj

(col-get arr jj)

Inputs: [arr :- Array jj :- s/Int] Returns: tsk/Vec

Gets an Array col

Inputs: [arr :- Array jj :- s/Int]
Returns: tsk/Vec

Gets an Array col
sourceraw docstring

col-setclj

(col-set arr jj new-col)

Inputs: [arr :- Array jj :- s/Int new-col :- tsk/Vec] Returns: Array

Sets an Array col

Inputs: [arr :- Array jj :- s/Int new-col :- tsk/Vec]
Returns: Array

Sets an Array col
sourceraw docstring

col-vals->arrayclj

(col-vals->array nrows ncols col-data)

Inputs: [nrows :- s/Int ncols :- s/Int col-data :- tsk/Vec] Returns: Array

Return a new Array of size=[nrows ncols] with its columns constructed from from col-data.

Inputs: [nrows :- s/Int ncols :- s/Int col-data :- tsk/Vec]
Returns: Array

Return a new Array of size=[nrows ncols] with its columns constructed from from col-data.
sourceraw docstring

cols->arrayclj

(cols->array col-vecs)

Inputs: [col-vecs :- [[s/Any]]] Returns: Array

[col-vecs] Return a new Array initialized from col-vecs. Cols must all have same length.

Inputs: [col-vecs :- [[s/Any]]]
Returns: Array

[col-vecs]
     Return a new Array initialized from col-vecs. Cols must all have same length.
sourceraw docstring

cols-appendclj

(cols-append arr & cols)

Inputs: [arr :- Array & cols :- [tsk/Vec]] Returns: Array

Appends one or more cols onto an array. Returns a new array.

Inputs: [arr :- Array & cols :- [tsk/Vec]]
Returns: Array

Appends one or more cols onto an array. Returns a new array.
sourceraw docstring

createclj

(create nrows ncols)
(create nrows ncols init-val)

Inputs: ([nrows :- s/Int ncols :- s/Int] [nrows :- s/Int ncols :- s/Int init-val :- s/Any]) Returns: Array

Return a new Array (vector-of-vectors) of size=[nrows ncols], initialized to init-val (default=nil)

Inputs: ([nrows :- s/Int ncols :- s/Int] [nrows :- s/Int ncols :- s/Int init-val :- s/Any])
Returns: Array

Return a new Array (vector-of-vectors) of size=[nrows ncols], initialized to `init-val` (default=nil)
sourceraw docstring

edn->arrayclj

(edn->array row-vecs)

Inputs: [row-vecs :- [[s/Any]]] Returns: Array

Synonym for rows->array

Inputs: [row-vecs :- [[s/Any]]]
Returns: Array

Synonym for rows->array
sourceraw docstring

elem-getclj

(elem-get arr ii jj)

Inputs: [arr :- Array ii :- s/Int jj :- s/Int] Returns: s/Any

Gets an Array element

Inputs: [arr :- Array ii :- s/Int jj :- s/Int]
Returns: s/Any

Gets an Array element
sourceraw docstring

elem-setclj

(elem-set arr ii jj newVal)

Inputs: [arr :- Array ii :- s/Int jj :- s/Int newVal :- s/Any] Returns: Array

Puts a value into an Array element, returning the updated Array.

Inputs: [arr :- Array ii :- s/Int jj :- s/Int newVal :- s/Any]
Returns: Array

Puts a value into an Array element, returning the updated Array.
sourceraw docstring

equalsclj

(equals x y)

Inputs: [x :- Array y :- Array] Returns: s/Bool

Returns true if two arrays contain equal data

Inputs: [x :- Array y :- Array]
Returns: s/Bool

Returns true if two arrays contain equal data
sourceraw docstring

flip-lrclj

(flip-lr orig)

Inputs: [orig :- Array] Returns: Array

Flips an array in the left-right direction, reversing the order of the cols of an array. Returns a new array.

Inputs: [orig :- Array]
Returns: Array

Flips an array in the left-right direction,
     reversing the order of the cols of an array. Returns a new array.
sourceraw docstring

flip-udclj

(flip-ud orig)

Inputs: [orig :- Array] Returns: Array

Flips an array in the up-down direction, reversing the order of the rows of an array. Returns a new array.

Inputs: [orig :- Array]
Returns: Array

Flips an array in the up-down direction,
     reversing the order of the rows of an array. Returns a new array.
sourceraw docstring

glue-horizclj

(glue-horiz & arrays)

Inputs: [& arrays :- [Array]] Returns: Array

Concatenates 2 or more arrays horizontally. All arrays must have the same number of rows. Returns a new array.

Inputs: [& arrays :- [Array]]
Returns: Array

Concatenates 2 or more arrays horizontally. All arrays must have the same number of rows. Returns a new array.
sourceraw docstring

glue-vertclj

(glue-vert & arrays)

Inputs: [& arrays :- [Array]] Returns: Array

Concatenates 2 or more arrays vertically. All arrays must have the same number of cols. Returns a new array.

Inputs: [& arrays :- [Array]]
Returns: Array

Concatenates 2 or more arrays vertically. All arrays must have the same number of cols. Returns a new array.
sourceraw docstring

num-colsclj

(num-cols arr)

Inputs: [arr :- Array] Returns: s/Int

Returns the number of cols of an Array.

Inputs: [arr :- Array]
Returns: s/Int

Returns the number of cols of an Array.
sourceraw docstring

num-rowsclj

(num-rows arr)

Inputs: [arr :- Array] Returns: s/Int

Returns the number of rows of an Array.

Inputs: [arr :- Array]
Returns: s/Int

Returns the number of rows of an Array.
sourceraw docstring

rotate-leftclj

(rotate-left orig)

Inputs: [orig :- Array] Returns: Array

Rotates an array 90 deg counter-clockwise. Returns a new array.

Inputs: [orig :- Array]
Returns: Array

Rotates an array 90 deg counter-clockwise. Returns a new array.
sourceraw docstring

rotate-rightclj

(rotate-right orig)

Inputs: [orig :- Array] Returns: Array

Rotates an array 90 deg counter-clockwise. Returns a new array.

Inputs: [orig :- Array]
Returns: Array

Rotates an array 90 deg counter-clockwise. Returns a new array.
sourceraw docstring

row-dropclj

(row-drop orig & idxs-drop)

Inputs: [orig :- Array & idxs-drop :- [s/Int]] Returns: Array

Drop one or more rows from an array

Inputs: [orig :- Array & idxs-drop :- [s/Int]]
Returns: Array

Drop one or more rows from an array
sourceraw docstring

row-getclj

(row-get arr ii)

Inputs: [arr :- Array ii :- s/Int] Returns: tsk/Vec

Gets an Array row

Inputs: [arr :- Array ii :- s/Int]
Returns: tsk/Vec

Gets an Array row
sourceraw docstring

row-setclj

(row-set arr ii new-row)

Inputs: [arr :- Array ii :- s/Int new-row :- tsk/Vec] Returns: Array

Sets an Array row

Inputs: [arr :- Array ii :- s/Int new-row :- tsk/Vec]
Returns: Array

Sets an Array row
sourceraw docstring

row-vals->arrayclj

(row-vals->array nrows ncols row-data)

Inputs: [nrows :- s/Int ncols :- s/Int row-data :- tsk/Vec] Returns: Array

Return a new Array of size=[nrows ncols] with its rows constructed from from row-data.

Inputs: [nrows :- s/Int ncols :- s/Int row-data :- tsk/Vec]
Returns: Array

Return a new Array of size=[nrows ncols] with its rows constructed from from row-data.
sourceraw docstring

rows->arrayclj

(rows->array row-vecs)

Inputs: [row-vecs :- [[s/Any]]] Returns: Array

Return a new Array initialized from row-vecs. Rows must all have same length.

Inputs: [row-vecs :- [[s/Any]]]
Returns: Array

Return a new Array initialized from row-vecs. Rows must all have same length.
sourceraw docstring

rows-appendclj

(rows-append arr & rows)

Inputs: [arr :- Array & rows :- [tsk/Vec]] Returns: Array

Appends one or more rows onto an array. Returns a new array.

Inputs: [arr :- Array & rows :- [tsk/Vec]]
Returns: Array

Appends one or more rows onto an array. Returns a new array.
sourceraw docstring

symmetric?clj

(symmetric? arr)

Inputs: [arr :- Array] Returns: s/Bool

Returns true iff an array is symmetric

Inputs: [arr :- Array]
Returns: s/Bool

Returns true iff an array is symmetric
sourceraw docstring

transposeclj

(transpose orig)

Inputs: [orig :- Array] Returns: Array

Returns the transpose of an array. Returns a new array.

Inputs: [orig :- Array]
Returns: Array

Returns the transpose of an array. Returns a new array.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close