ComplexArray

A ComplexArray.

Factories

array(const List list) -> ComplexArray

Converts a list or list of list to a array.

Parameters

• list: The list containing the values.

array(const ComplexArray lhs) -> ComplexArray

Converts a container to an array.

Parameters

• lhs: The container.

array(const ComplexMatrix lhs) -> ComplexArray

Converts a container to an array.

Parameters

• lhs: The container.

array(const ComplexSparseMatrix lhs) -> ComplexArray

Converts a container to an array.

Parameters

• lhs: The container.

array(const RealArray lhs, as_complex type) -> ComplexArray

Converts a container to an array.

Parameters

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

array(const BoolArray lhs, as_complex type) -> ComplexArray

Converts a container to an array.

Parameters

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

array(const IntegerArray lhs, as_complex type) -> ComplexArray

Converts a container to an array.

Parameters

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

array(const ComplexMatrix lhs, as_complex type) -> ComplexArray

Converts a container to an array.

Parameters

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

array(const List list, as_complex type) -> ComplexArray

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 ComplexSparseMatrix lhs, as_complex type) -> ComplexArray

Converts a container to an array.

Parameters

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

array(const RealSparseMatrix lhs, as_complex type) -> ComplexArray

Converts a container to an array.

Parameters

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

array(const List list, as_scalar type) -> ComplexArray

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 ComplexArray lhs, as_complex type) -> ComplexArray

Converts a container to an array.

Parameters

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

array(const RealMatrix lhs, as_complex type) -> ComplexArray

Converts a container to an array.

Parameters

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

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

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_array type) -> ComplexArray

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_array type) -> ComplexArray

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_complex | as_array type) -> ComplexArray

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, complex value, as_complex | as_array type) -> ComplexArray

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, bool value, as_array type) -> ComplexArray

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, bool value, as_complex | as_array type) -> ComplexArray

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, complex value, as_array type) -> ComplexArray

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 ComplexArray lhs, bool c) -> ComplexArray

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 ComplexArray lhs, complex c) -> ComplexArray

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 ComplexArray lhs, real c) -> ComplexArray

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 ComplexArray lhs, integer c) -> ComplexArray

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_complex | as_array type) -> ComplexArray

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(const List<integer> shape, as_array type) -> ComplexArray

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 ComplexArray lhs) -> ComplexArray

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

Parameters

• lhs: The input container.

ones(const List<integer> shape, as_complex | as_array type) -> ComplexArray

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(const List<integer> shape, as_array type) -> ComplexArray

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 ComplexArray lhs) -> ComplexArray

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_array type) -> ComplexArray

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.

random(const List<integer> shape, as_complex | as_array type) -> ComplexArray

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_array type) -> ComplexArray

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(const List<integer> shape, as_complex | as_array type) -> ComplexArray

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 ComplexArray lhs) -> ComplexArray

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_complex | as_array type) -> ComplexArray

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(const List<integer> shape, as_array type) -> ComplexArray

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 ComplexArray lhs) -> ComplexArray

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

Parameters

• lhs: The input container.

Constructors

ComplexArray() -> ComplexArray

Creates an empty ComplexArray.

ComplexArray(integer m) -> ComplexArray

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

Parameters

• m: The number of rows.

ComplexArray(const List list) -> ComplexArray

Creates an ComplexArray from a list of lists of elements.

Parameters

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

ComplexArray(integer m, integer n) -> ComplexArray

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

Parameters

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

Symbols

Name	Description
[]	Gets or sets the element at index i of the ComplexArray.

Members

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