RealArray

A RealArray.

Factories

array(const RealSparseMatrix lhs) -> RealArray

Converts a container to an array.

Parameters

• lhs: The container.

array(const RealMatrix lhs) -> RealArray

Converts a container to an array.

Parameters

• lhs: The container.

array(const RealArray lhs) -> RealArray

Converts a container to an array.

Parameters

• lhs: The container.

array(const RealSparseMatrix lhs, as_real type) -> RealArray

Converts a container to an array.

Parameters

• lhs: The container.
• type: The type of the array to create.

array(const List list, as_real type) -> RealArray

Converts a list or list of list to an array.

Parameters

• list: The list containing the values.
• type: The type of the container to create.

array(const IntegerArray lhs, as_real type) -> RealArray

Converts a container to an array.

Parameters

• lhs: The container.
• type: The type of the array to create.

array(const RealArray lhs, as_real type) -> RealArray

Converts a container to an array.

Parameters

• lhs: The container.
• type: The type of the array to create.

array(const BoolArray lhs, as_real type) -> RealArray

Converts a container to an array.

Parameters

• lhs: The container.
• type: The type of the array to create.

array(const RealMatrix lhs, as_real type) -> RealArray

Converts a container to an array.

Parameters

• lhs: The container.
• type: The type of the array to create.

filled(const List<integer> shape, bool value, as_real | as_array type) -> RealArray

Creates a container with the specified shape and type, filled with with the specified value.

Parameters

• shape: The shape of the container to create.
• value: The value with which to fill the container.
• type: The type of the container to create.

filled(const List<integer> shape, integer value, as_real | as_array type) -> RealArray

Creates a container with the specified shape and type, filled with with the specified value.

Parameters

• shape: The shape of the container to create.
• value: The value with which to fill the container.
• type: The type of the container to create.

filled(const List<integer> shape, real value, as_real | as_array type) -> RealArray

Creates a container with the specified shape and type, filled with with the specified value.

Parameters

• shape: The shape of the container to create.
• value: The value with which to fill the container.
• type: The type of the container to create.

filled_like(const RealArray lhs, integer c) -> RealArray

Return a container with the same shape and type as a given container, filled with a prescribed value.

Parameters

• lhs: The input container.
• c: The constant value to fill with.

filled_like(const RealArray lhs, bool c) -> RealArray

Return a container with the same shape and type as a given container, filled with a prescribed value.

Parameters

• lhs: The input container.
• c: The constant value to fill with.

filled_like(const RealArray lhs, real c) -> RealArray

Return a container with the same shape and type as a given container, filled with a prescribed value.

Parameters

• lhs: The input container.
• c: The constant value to fill with.

identity(const List<integer> shape, as_real | as_array type) -> RealArray

Creates an identity matrix (or array; possibly rectangular) with the specified shape and type.

Parameters

• shape: The shape of the container to create.
• type: The type of the container to create.

identity_like(const RealArray lhs) -> RealArray

Return the identity with the same shape and type as a given container.

Parameters

• lhs: The input container.

ones(const List<integer> shape, as_real | as_array type) -> RealArray

Creates a container with the specified shape and type, filled with ones.

Parameters

• shape: The shape of the container to create.
• type: The type of the container to create.

ones_like(const RealArray lhs) -> RealArray

Return a container of ones with the same shape and type as a given container.

Parameters

• lhs: The input container.

random(const List<integer> shape, as_real | as_array type) -> RealArray

Creates a container with the specified shape and type, filled with random values.

Parameters

• shape: The shape of the container to create.
• type: The type of the container to create.

uninitialized(const List<integer> shape, as_real | as_array type) -> RealArray

Creates a container with the specified shape and type.

Parameters

• shape: The shape of the container to create.
• type: The type of the container to create.

uninitialized_like(const RealArray lhs) -> RealArray

Return a container of uninitialized values with the same shape and type as a given container.

Parameters

• lhs: The input container.

zeros(const List<integer> shape, as_real | as_array type) -> RealArray

Creates a container with the specified shape and type, filled with zeros.

Parameters

• shape: The shape of the container to create.
• type: The type of the container to create.

zeros_like(const RealArray lhs) -> RealArray

Return a container of zeros with the same shape and type as a given container.

Parameters

• lhs: The input container.

Constructors

RealArray() -> RealArray

Creates an empty RealArray.

RealArray(integer m) -> RealArray

Creates an m x 1 RealArray. The array comes out uninitialized.

Parameters

• m: The number of rows.

RealArray(const List list) -> RealArray

Creates an RealArray from a list of lists of elements.

Parameters

• list: A list of elements to populate the column array.

RealArray(integer m, integer n) -> RealArray

Creates an m x n RealArray. The array comes out uninitialized.

Parameters

• m: The number of rows.
• n: The number of columns.

Symbols

Name	Description
[]	Gets or sets the elements of the RealArray using slices.

Members

Name	Description
all	Returns true if all elements of the RealArray are finite.
all_finite	Returns true if all elements of the RealArray are finite.
any	Returns true if any element of the RealArray is finite.
block	Get a block (sub-RealArray) of the RealArray.
bottom_left_corner	Get the bottom-left corner of the RealArray.
bottom_right_corner	Get the bottom-right corner of the RealArray.
bottom_rows	Get the bottom rows of the RealArray.
col	Get a column of the RealArray.
cols	Returns the number of columns of a RealArray.
container_type	Returns the underlying container type of the RealArray.
count	Counts the number of finite elements in the RealArray.
fill	Sets all elements of the RealArray lhs to the constant c.
flatten	Flattens the RealArray in-place.
flattened	Returns a flattened copy of the RealArray.
flip	Flips the RealArray along the specified dimension.
flipped	Returns a RealArray flipped along the specified dimension.
has_nan	Returns true if the RealArray has any NaN (not-a-number) elements.
is_approx	Returns true if the RealArray lhs is approximately equal to the RealArray rhs.
is_approx_to_constant	Returns true if all elements of the RealArray lhs are approximately equal to the constant val.
is_array	Whether the container is an array (which supports elementwise operations).
is_bool	Whether the underlying scalar type of the RealArray is bool.
is_column_vector	Returns true if the container is a column-vector.
is_complex	Whether the underlying scalar type of the RealArray is complex.
is_constant	Returns true if all elements of the RealArray lhs are the same.
is_dense	Whether the container is dense.
is_integer	Whether the underlying scalar type of the RealArray is integer.
is_matrix	Whether the container is a matrix (which supports matrix algebra).
is_much_smaller_than	Returns true if the norm of the RealArray lhs is much smaller than the norm of the RealArray rhs, within the specified tolerance.
is_ones	Returns true if all elements of the RealArray lhs are 1.
is_real	Whether the underlying scalar type of the RealArray is real.
is_row_vector	Returns true if the container is a row-vector.
is_scalar	Returns true if the container is a scalar (or a container containing a single element).
is_sparse	Whether the container is sparse.
is_vector	Returns true if the container is a vector.
is_zero	Returns true if all elements of the RealArray lhs are 0.
left_cols	Get the left columns of the RealArray.
list	Converts the RealArray arr to a list with the same elements.
lrflip	Flips the RealArray left-right (i.e. flips each row).
lrflipped	Returns a RealArray flipped left-right (rows; along the 1-st dimension).
middle_cols	Get the middle columns of the RealArray.
middle_rows	Get the middle rows of the RealArray.
random_like	Return a RealArray of random numbers with the same shape and type as a given RealArray.
real	Returns the real component of a RealArray.
replicate	Replicates the elements of the RealArray lhs in-place by the specified factors.
replicated	Replicates the elements of the RealArray lhs by the specified factors.
reshape	Reshapes the RealArray in-place to the given dimensions.
reshaped	Reshapes the RealArray to the given dimensions.
resize	Resizes the RealArray lhs to the given size.
reverse	Reverses the RealArray in place.
reversed	Returns a reversed copy of the RealArray.
right_cols	Get the right columns of the RealArray.
rotate	Returns a (counter-clockwise) rotated copy of the RealArray.
rotated	Returns a (counter-clockwise) rotated copy of the RealArray.
row	Get a row of the RealArray.
rows	Returns the number of rows of a RealArray.
scalar_type	Returns the underlying scalar type of the RealArray.
select	Gets or sets the elements of the RealArray using slices.
set_block	Sets a block of the RealArray lhs to the values in the RealArray rhs.
set_bottom_left_corner	Get the bottom-left corner of the RealArray.
set_bottom_right_corner	Get the bottom-right corner of the RealArray.
set_bottom_rows	Get the bottom rows of the RealArray.
set_col	Get a column of the RealArray.
set_constant	Sets all elements of the RealArray lhs to the constant c.
set_left_cols	Get the left columns of the RealArray.
set_middle_cols	Get the middle columns of the RealArray.
set_middle_rows	Get the middle rows of the RealArray.
set_ones	Sets all elements of the RealArray lhs to 1.
set_random	Sets all elements of the RealArray lhs to random values on the interval [0, 1].
set_right_cols	Get the right columns of the RealArray.
set_row	Get a row of the RealArray.
set_select	Assign the values of rhs to a selection of the RealArray lhs.
set_top_left_corner	Get the top-left corner of the RealArray.
set_top_right_corner	Get the top-right corner of the RealArray.
set_top_rows	Get the top rows of the RealArray.
set_zero	Sets all elements of the RealArray lhs to 0.
shape	Returns the shape of a RealArray.
shift	Returns a (periodically) shifted copy of the RealArray.
shifted	Returns a (periodically) shifted copy of the RealArray.
size	Returns the number of elements of a RealArray.
swap	Swaps the contents of the RealArray lhs and rhs.
top_left_corner	Get the top-left corner of the RealArray.
top_right_corner	Get the top-right corner of the RealArray.
top_rows	Get the top rows of the RealArray.
transpose	Transposes the RealArray in place.
udflip	Flips the RealArray up-down (i.e. flips each column).
udflipped	Returns a RealArray flipped up-down (columns; along the 0-th dimension).
value	Returns the unique coefficient of a 1x1 RealArray.