picos

A Python Interface to Conic Optimization Solvers.

The picos namespace gives you quick access to the most important classes and functions for optimizing with PICOS, so that import picos is often sufficient for implementing your model.

Exceptions

exception picos.NotValued[source]

See picos.valuable.NotValued.

exception picos.SolutionFailure[source]

See picos.modeling.problem.SolutionFailure.

Classes

class picos.Ball[source]

See picos.expressions.set_ball.Ball.

class picos.BinaryVariable[source]

See picos.expressions.variables.BinaryVariable.

class picos.ComplexVariable[source]

See picos.expressions.variables.ComplexVariable.

class picos.DetRootN[source]

See picos.expressions.exp_detrootn.DetRootN.

class picos.Ellipsoid[source]

See picos.expressions.set_ellipsoid.Ellipsoid.

class picos.Entropy[source]

See picos.expressions.exp_entropy.Entropy.

class picos.ExponentialCone[source]

See picos.expressions.cone_expcone.ExponentialCone.

class picos.FlowConstraint[source]

See picos.constraints.con_flow.FlowConstraint.

class picos.GeometricMean[source]

See picos.expressions.exp_geomean.GeometricMean.

class picos.HermitianVariable[source]

See picos.expressions.variables.HermitianVariable.

class picos.IntegerVariable[source]

See picos.expressions.variables.IntegerVariable.

class picos.LogSumExp[source]

See picos.expressions.exp_logsumexp.LogSumExp.

class picos.Logarithm[source]

See picos.expressions.exp_logarithm.Logarithm.

class picos.LowerTriangularVariable[source]

See picos.expressions.variables.LowerTriangularVariable.

class picos.NegativeEntropy[source]

See picos.expressions.exp_entropy.NegativeEntropy.

class picos.NonnegativeOrthant[source]

See picos.expressions.cone_nno.NonnegativeOrthant.

class picos.Norm[source]

See picos.expressions.exp_norm.Norm.

class picos.NuclearNorm[source]

See picos.expressions.exp_nucnorm.NuclearNorm.

class picos.Objective[source]

See picos.modeling.objective.Objective.

class picos.Options[source]

See picos.modeling.options.Options.

class picos.PositiveSemidefiniteCone[source]

See picos.expressions.cone_psd.PositiveSemidefiniteCone.

class picos.PowerTrace[source]

See picos.expressions.exp_powtrace.PowerTrace.

class picos.Problem[source]

See picos.modeling.problem.Problem.

class picos.ProductCone[source]

See picos.expressions.cone_product.ProductCone.

class picos.RealVariable[source]

See picos.expressions.variables.RealVariable.

class picos.RotatedSecondOrderCone[source]

See picos.expressions.cone_rsoc.RotatedSecondOrderCone.

class picos.Samples[source]

See picos.expressions.samples.Samples.

class picos.SecondOrderCone[source]

See picos.expressions.cone_soc.SecondOrderCone.

class picos.Simplex[source]

See picos.expressions.set_simplex.Simplex.

class picos.SkewSymmetricVariable[source]

See picos.expressions.variables.SkewSymmetricVariable.

class picos.Solution[source]

See picos.modeling.solution.Solution.

class picos.SpectralNorm[source]

See picos.expressions.exp_specnorm.SpectralNorm.

class picos.SquaredNorm[source]

See picos.expressions.exp_sqnorm.SquaredNorm.

class picos.SumExponentials[source]

See picos.expressions.exp_sumexp.SumExponentials.

class picos.SumExtremes[source]

See picos.expressions.exp_sumxtr.SumExtremes.

class picos.SymmetricVariable[source]

See picos.expressions.variables.SymmetricVariable.

class picos.TheField[source]

See picos.expressions.cone_trivial.TheField.

class picos.UpperTriangularVariable[source]

See picos.expressions.variables.UpperTriangularVariable.

class picos.ZeroSpace[source]

See picos.expressions.cone_trivial.ZeroSpace.

Functions

picos.Constant()[source]

See picos.expressions.exp_affine.Constant.

picos.ascii()[source]

See picos.glyphs.ascii.

picos.available_solvers()[source]

See picos.solvers.available_solvers.

picos.ball()

See picos.expressions.algebra.ball.

picos.block()[source]

See picos.expressions.algebra.block.

picos.default_charset()

See picos.glyphs.unicode.

picos.detrootn()

See picos.expressions.algebra.detrootn.

picos.diag()[source]

See picos.expressions.algebra.diag.

picos.diag_vect()[source]

See picos.expressions.algebra.diag_vect.

picos.exp()[source]

See picos.expressions.algebra.exp.

picos.expcone()

See picos.expressions.algebra.expcone.

picos.find_assignment()[source]

See picos.modeling.quicksolve.find_assignment.

picos.flow_Constraint()[source]

See picos.expressions.algebra.flow_Constraint.

picos.geomean()

See picos.expressions.algebra.geomean.

picos.import_cbf()[source]

See picos.modeling.file_in.import_cbf.

picos.kldiv()

See picos.expressions.algebra.kldiv.

picos.kron()[source]

See picos.expressions.algebra.kron.

picos.kullback_leibler()

See picos.expressions.algebra.kullback_leibler.

picos.lambda_max()[source]

See picos.expressions.algebra.lambda_max.

picos.lambda_min()[source]

See picos.expressions.algebra.lambda_min.

picos.latin1()[source]

See picos.glyphs.latin1.

picos.log()[source]

See picos.expressions.algebra.log.

picos.logsumexp()

See picos.expressions.algebra.logsumexp.

picos.lse()

See picos.expressions.algebra.lse.

picos.maindiag()[source]

See picos.expressions.algebra.maindiag.

picos.max()[source]

See picos.expressions.algebra.max.

picos.maximize()[source]

See picos.modeling.quicksolve.maximize.

picos.min()[source]

See picos.expressions.algebra.min.

picos.minimize()[source]

See picos.modeling.quicksolve.minimize.

picos.mtxgeomean()

See picos.expressions.algebra.oprelentr.

picos.new_param()[source]

See picos.expressions.algebra.new_param.

picos.norm()

See picos.expressions.algebra.norm.

picos.oprelentr()

See picos.expressions.algebra.oprelentr.

picos.partial_trace()[source]

See picos.expressions.algebra.partial_trace.

picos.partial_transpose()[source]

See picos.expressions.algebra.partial_transpose.

picos.patch_scipy_array_priority()[source]

See picos.valuable.patch_scipy_array_priority.

picos.quantcondentr()

See picos.expressions.algebra.quantcondentr.

picos.quantentr()

See picos.expressions.algebra.quantentr.

picos.quantkeydist()

See picos.expressions.algebra.quantkeydist.

picos.quantrelentr()

See picos.expressions.algebra.quantrelentr.

picos.quasientr()

See picos.expressions.algebra.quasientr.

picos.renyientr()

See picos.expressions.algebra.renyientr.

picos.rsoc()

See picos.expressions.algebra.rsoc.

picos.sandquasientr()

See picos.expressions.algebra.sandquasientr.

picos.sandrenyientr()

See picos.expressions.algebra.sandrenyientr.

picos.simplex()[source]

See picos.expressions.algebra.simplex.

picos.soc()

See picos.expressions.algebra.soc.

picos.sum()[source]

See picos.expressions.algebra.sum.

picos.sum_k_largest()[source]

See picos.expressions.algebra.sum_k_largest.

picos.sum_k_largest_lambda()[source]

See picos.expressions.algebra.sum_k_largest_lambda.

picos.sum_k_smallest()[source]

See picos.expressions.algebra.sum_k_smallest.

picos.sum_k_smallest_lambda()[source]

See picos.expressions.algebra.sum_k_smallest_lambda.

picos.sumexp()

See picos.expressions.algebra.sumexp.

picos.trace()[source]

See picos.expressions.algebra.trace.

picos.tracepow()[source]

See picos.expressions.algebra.tracepow.

picos.truncated_simplex()[source]

See picos.expressions.algebra.truncated_simplex.

picos.unicode()[source]

See picos.glyphs.unicode.

picos.value()[source]

See picos.expressions.data.value.

Objects

picos.I[source]

Create an identity matrix.

Example

>>> from picos import I
>>> print(I(3))
[ 1.00e+00     0         0    ]
[    0      1.00e+00     0    ]
[    0         0      1.00e+00]
Default value
<functools._lru_cache_wrapper object at 0x7dc2145ff7f0>
picos.J[source]

Create a matrix of all ones.

Example

>>> from picos import J
>>> print(J(2, 3))
[ 1.00e+00  1.00e+00  1.00e+00]
[ 1.00e+00  1.00e+00  1.00e+00]
Default value
<functools._lru_cache_wrapper object at 0x7dc2145ff8a0>
picos.O[source]

Create a zero matrix.

Example

>>> from picos import O
>>> print(O(2, 3))
[0 0 0]
[0 0 0]
Default value
<functools._lru_cache_wrapper object at 0x7dc2145ff740>