picos.tools

Backwards compatibility version of an older module.

Functions

picos.tools.ball()

See picos.expressions.algebra.ball.

picos.tools.detect_range()[source]

See picos.formatting.detect_range.

picos.tools.detrootn()

See picos.expressions.algebra.detrootn.

picos.tools.diag()[source]

See picos.expressions.algebra.diag.

picos.tools.diag_vect()[source]

See picos.expressions.algebra.diag_vect.

picos.tools.eval_dict(dict_of_variables)[source]

Evaluate all values of a dictionary.

Parameters

dict_of_variables (dict) – A dictionary mapping arbitrary keys to PICOS objects that have a value attribute, such as variables.

Returns

Another dictionary with the original dicitonary’s values replaced by the value of their value attribute.

Deprecated since version 2.0: Write ‘{k: v.value for k, v in x.items()}’ instead.

picos.tools.exp()[source]

See picos.expressions.algebra.exp.

picos.tools.expcone()

See picos.expressions.algebra.expcone.

picos.tools.flow_Constraint()[source]

See picos.expressions.algebra.flow_Constraint.

picos.tools.geomean()

See picos.expressions.algebra.geomean.

picos.tools.import_cbf()[source]

See picos.modeling.file_in.import_cbf.

picos.tools.kron()[source]

See picos.expressions.algebra.kron.

picos.tools.kullback_leibler()

See picos.expressions.algebra.kullback_leibler.

picos.tools.lambda_max()[source]

See picos.expressions.algebra.lambda_max.

picos.tools.lambda_min()[source]

See picos.expressions.algebra.lambda_min.

picos.tools.log()[source]

See picos.expressions.algebra.log.

picos.tools.logsumexp()

See picos.expressions.algebra.logsumexp.

picos.tools.lse()

See picos.expressions.algebra.lse.

picos.tools.new_param()[source]

See picos.expressions.algebra.new_param.

picos.tools.norm()

See picos.expressions.algebra.norm.

picos.tools.parameterized_string()[source]

See picos.formatting.parameterized_string.

picos.tools.partial_trace()[source]

See picos.expressions.algebra.partial_trace.

picos.tools.partial_transpose()[source]

See picos.expressions.algebra.partial_transpose.

picos.tools.retrieve_matrix(mat, exSize=None)[source]

Legacy wrapper around load_data.

Deprecated since version 2.0: Use picos.expressions.data.load_data instead.

picos.tools.simplex()[source]

See picos.expressions.algebra.simplex.

picos.tools.sum()[source]

See picos.expressions.algebra.sum.

picos.tools.sum_k_largest()[source]

See picos.expressions.algebra.sum_k_largest.

picos.tools.sum_k_largest_lambda()[source]

See picos.expressions.algebra.sum_k_largest_lambda.

picos.tools.sum_k_smallest()[source]

See picos.expressions.algebra.sum_k_smallest.

picos.tools.sum_k_smallest_lambda()[source]

See picos.expressions.algebra.sum_k_smallest_lambda.

picos.tools.sumexp()

See picos.expressions.algebra.sumexp.

picos.tools.trace()[source]

See picos.expressions.algebra.trace.

picos.tools.tracepow()[source]

See picos.expressions.algebra.tracepow.

picos.tools.truncated_simplex()[source]

See picos.expressions.algebra.truncated_simplex.

Objects

picos.tools.builtin_sum

Return the sum of a ‘start’ value (default: 0) plus an iterable of numbers

When the iterable is empty, return the start value. This function is intended specifically for use with numeric values and may reject non-numeric types.

Default value
<built-in function sum>