CLLS

purpose

The clls package uses a primal-dual interior-point crossover method to solve a constrained linear least-squares problem The aim is to minimize the (regularized) least-squares objective function

\[q(x) = \frac{1}{2} \| A_o x - b\|_W^2 + \frac{1}{2}\sigma \|x\|^2\]

subject to the general linear constraints and simple bounds

\[c_l \leq A x \leq c_u \;\;\mbox{and} \;\; x_l \leq x \leq x_u,\]

where the norms \(\|r\|_W = \sqrt{\sum_{i=1}^o w_i r_i^2}\) and \(\|x\| = \sqrt{\sum_{i=1}^n x_i^2}\), \(A_o\) and \(A\) are, respectively, given \(o\) by \(n\) and \(m\) by \(n\) matrices, \(b\), and \(w\) are vectors, \(\sigma \geq 0\) is a scalar, and any of the components of the vectors \(c_l\), \(c_u\), \(x_l\) or \(x_u\) may be infinite. The method offers the choice of direct and iterative solution of the key regularization subproblems, and is most suitable for problems involving a large number of unknowns \(x\).

See Section 4 of $GALAHAD/doc/clls.pdf for additional details.

terminology

Any required solution \(x\) necessarily satisfies the primal optimality conditions

\[A x = c\;\;\mbox{(1a)}\]

and

\[c_l \leq c \leq c_u, \;\; x_l \leq x \leq x_u,\;\;\mbox{(1b)}\]

the dual optimality conditions

\[A_o^T W ( A_o x-b ) + \sigma x = A^{T} y + z,\;\; y = y_l + y_u \;\;\mbox{and}\;\; z = z_l + z_u,\;\;\mbox{(2a)}\]

and

\[y_l \geq 0, \;\; y_u \leq 0, \;\; z_l \geq 0 \;\;\mbox{and}\;\; z_u \leq 0,\;\;\mbox{(2b)}\]

and the complementary slackness conditions

\[( A x - c_l )^{T} y_l = 0,\;\; ( A x - c_u )^{T} y_u = 0,\;\; (x -x_l )^{T} z_l = 0 \;\;\mbox{and}\;\;(x -x_u )^{T} z_u = 0,\;\;\mbox{(3)}\]

where the vectors \(y\) and \(z\) are known as the Lagrange multipliers for the general linear constraints, and the dual variables for the bounds, respectively, where the vector inequalities hold component-wise, and where \(W\) is the diagonal matrix whose entries are the \(w_j\).

method

Primal-dual interior point methods iterate towards a point that satisfies these optimality conditions by ultimately aiming to satisfy (1a), (2a) and (3), while ensuring that (1b) and (2b) are satisfied as strict inequalities at each stage. Appropriate norms of the amounts by which (1a), (2a) and (3) fail to be satisfied are known as the primal and dual infeasibility, and the violation of complementary slackness, respectively. The fact that (1b) and (2b) are satisfied as strict inequalities gives such methods their other title, namely interior-point methods.

The method aims at each stage to reduce the overall violation of (1a), (2a) and (3), rather than reducing each of the terms individually. Given an estimate \(v = (x, \; c, \; y, \; y^{l}, \; y^{u}, \; z, \; z^{l}, \; z^{u})\) of the primal-dual variables, a correction \(\Delta v = \Delta (x, \; c, \; y, \; y^{l}, \; y^{u} ,\;z,\;z^{l} ,\;z^{u} )\) is obtained by solving a suitable linear system of Newton equations for the nonlinear systems (1a), (2a) and a parameterized ``residual trajectory’’ perturbation of (3); residual trajectories proposed by Zhang (1994) and Zhao and Sun (1999) are possibilities. An improved estimate \(v + \alpha \Delta v\) is then used, where the step-size \(\alpha\) is chosen as close to 1.0 as possible while ensuring both that (1b) and (2b) continue to hold and that the individual components which make up the complementary slackness (3) do not deviate too significantly from their average value. The parameter that controls the perturbation of (3) is ultimately driven to zero.

If the algorithm believes that it is close to the solution, it may take a speculative ``pounce’’, based on an estimate of the ultimate active set, to avoid further costly iterations. If the pounce is unsuccessful, the iteration continues, and further pounces may be attempted later.

The Newton equations are solved by applying the matrix factorization package SLS. Optionally, the problem may be pre-processed temporarily to eliminate dependent constraints using the package FDC. This may improve the performance of the subsequent iteration.

references

The basic algorithm is a generalisation of those of

Y. Zhang, ``On the convergence of a class of infeasible interior-point methods for the horizontal linear complementarity problem’’. SIAM J. Optimization 4(1) (1994) 208-227,

and

G. Zhao and J. Sun, ``On the rate of local convergence of high-order infeasible path-following algorithms for \(P_*\) linear complementarity problems’’. Computational Optimization and Applications **14(1)* (1999) 293-307,

with many enhancements described by

N. I. M. Gould, D. Orban and D. P. Robinson, ``Trajectory-following methods for large-scale degenerate convex quadratic programming’’, Mathematical Programming Computation 5(2) (2013) 113-142

and tailored for a regularized linear least-squares objective.

matrix storage

The unsymmetric \(m\) by \(n\) and \(o\) by \(n\) matrices \(A\) and \(A_o\) may be presented and stored in a variety of convenient input formats. Let \(A\) be \(A_o\) (with \(o\) instead of \(m\)) below as appropriate.

Dense storage format: The matrix \(A\) is stored as a compact dense matrix by rows, that is, the values of the entries of each row in turn are stored in order within an appropriate real one-dimensional array. In this case, component \(n \ast i + j\) of the storage array A_val will hold the value \(A_{ij}\) for \(0 \leq i \leq m-1\), \(0 \leq j \leq n-1\). The string A_type = ‘dense’ should be specified.

Dense by columns storage format: The matrix \(A\) is stored as a compact dense matrix by columns, that is, the values of the entries of each column in turn are stored in order within an appropriate real one-dimensional array. In this case, component \(m \ast j + i\) of the storage array A_val will hold the value \(A_{ij}\) for \(0 \leq i \leq m-1\), \(0 \leq j \leq n-1\). The string A_type = ‘dense_by_columns’ should be specified.

Sparse co-ordinate storage format: Only the nonzero entries of the matrices are stored. For the \(l\)-th entry, \(0 \leq l \leq ne-1\), of \(A\), its row index i, column index j and value \(A_{ij}\), \(0 \leq i \leq m-1\), \(0 \leq j \leq n-1\), are stored as the \(l\)-th components of the integer arrays A_row and A_col and real array A_val, respectively, while the number of nonzeros is recorded as A_ne = \(ne\). The string A_type = ‘coordinate’should be specified.

Sparse row-wise storage format: Again only the nonzero entries are stored, but this time they are ordered so that those in row i appear directly before those in row i+1. For the i-th row of \(A\) the i-th component of the integer array A_ptr holds the position of the first entry in this row, while A_ptr(m) holds the total number of entries. The column indices j, \(0 \leq j \leq n-1\), and values \(A_{ij}\) of the nonzero entries in the i-th row are stored in components l = A_ptr(i), \(\ldots\), A_ptr(i+1)-1, \(0 \leq i \leq m-1,\) of the integer array A_col, and real array A_val, respectively. For sparse matrices, this scheme almost always requires less storage than its predecessor. The string A_type = ‘sparse_by_rows’ should be specified.

Sparse column-wise storage format: Once again only the nonzero entries are stored, but this time they are ordered so that those in column j appear directly before those in column j+1. For the j-th column of \(A\) the j-th component of the integer array A_ptr holds the position of the first entry in this column, while A_ptr(n) holds the total number of entries. The row indices i, \(0 \leq i \leq m-1\), and values \(A_{ij}\) of the nonzero entries in the j-th columns are stored in components l = A_ptr(j), \(\ldots\), A_ptr(j+1)-1, \(0 \leq j \leq n-1\), of the integer array A_row, and real array A_val, respectively. As before, for sparse matrices, this scheme almost always requires less storage than the co-ordinate format. The string A_type = ‘sparse_by_columns’ should be specified.

functions

clls.initialize()

Set default option values and initialize private data

Returns:

optionsdict

dictionary containing default control options:

errorint

error and warning diagnostics occur on stream error.

outint

general output occurs on stream out.

print_levelint

the level of output required is specified by print_level. Possible values are

• <=0

  gives no output,

• 1

  gives a one-line summary for every iteration.

• 2

  gives a summary of the inner iteration for each iteration.

• >=3

  gives increasingly verbose (debugging) output.

start_printint

any printing will start on this iteration.

stop_printint

any printing will stop on this iteration.

maxitint

at most maxit inner iterations are allowed.

infeas_maxint

the number of iterations for which the overall infeasibility of the problem is not reduced by at least a factor reduce_infeas before the problem is flagged as infeasible (see reduce_infeas).

muzero_fixedint

the initial value of the barrier parameter will not be changed for the first muzero_fixed iterations.

restore_problemint

indicate whether and how much of the input problem should be restored on output. Possible values are

• 0

  nothing restored.

• 1

  scalar and vector parameters.

• 2

  all parameters.

indicator_typeint

specifies the type of indicator function used. Possible values are

• 1

  primal indicator: a constraint is active if and only if the distance to its nearest bound <= indicator_p_tol.

• 2

  primal-dual indicator: a constraint is active if and only if the distance to its nearest bound <= indicator_tol_pd times the size of the corresponding multiplier.

• 3

  primal-dual indicator: a constraint is active if and only if the distance to its nearest bound <= indicator_tol_tapia times the distance to same bound at the previous iteration.

arcint

which residual trajectory should be used to aim from the current iterate to the solution. Possible values are

• 1

  the Zhang linear residual trajectory.

• 2

  the Zhao-Sun quadratic residual trajectory.

• 3

  the Zhang arc ultimately switching to the Zhao-Sun residual trajectory.

• 4

  the mixed linear-quadratic residual trajectory.

• 5

  the Zhang arc ultimately switching to the mixed linear-quadratic residual trajectory.

series_orderint

the order of (Taylor/Puiseux) series to fit to the path data.

sif_file_deviceint

specifies the unit number to write generated SIF file describing the current problem.

qplib_file_deviceint

specifies the unit number to write generated QPLIB file describing the current problem.

infinityfloat

any bound larger than infinity in modulus will be regarded as infinite.

stop_abs_pfloat

the required absolute and relative accuracies for the primal infeasibility.

stop_rel_pfloat

see stop_abs_p.

stop_abs_dfloat

the required absolute and relative accuracies for the dual infeasibility.

stop_rel_dfloat

see stop_abs_d.

stop_abs_cfloat

the required absolute and relative accuracies for the complementarity.

stop_rel_cfloat

see stop_abs_c.

prfeasfloat

initial primal variables will not be closer than prfeas from their bounds.

dufeasfloat

initial dual variables will not be closer than dufeas from their bounds.

muzerofloat

the initial value of the barrier parameter. If muzero is not positive, it will be reset to an appropriate value.

taufloat

the weight attached to primal-dual infeasibility compared to complementa when assessing step acceptance.

gamma_cfloat

individual complementarities will not be allowed to be smaller than gamma_c times the average value.

gamma_ffloat

the average complementarity will not be allowed to be smaller than gamma_f times the primal/dual infeasibility.

reduce_infeasfloat

if the overall infeasibility of the problem is not reduced by at least a factor reduce_infeas over infeas_max iterations, the problem is flagged as infeasible (see infeas_max).

identical_bounds_tolfloat

any pair of constraint bounds \((c_l,c_u)\) or \((x_l,x_u)\) that are closer than identical_bounds_tol will be reset to the average of their values.

mu_pouncefloat

start terminal extrapolation when mu reaches mu_pounce.

indicator_tol_pfloat

if indicator_type = 1, a constraint/bound will be deemed to be active if and only if the distance to its nearest bound <= indicator_p_tol.

indicator_tol_pdfloat

if indicator_type = 2, a constraint/bound will be deemed to be active if and only if the distance to its nearest bound <= indicator_tol_pd * size of corresponding multiplier.

indicator_tol_tapiafloat

if indicator_type = 3, a constraint/bound will be deemed to be active if and only if the distance to its nearest bound <= indicator_tol_tapia * distance to same bound at previous iteration.

cpu_time_limitfloat

the maximum CPU time allowed (-ve means infinite).

clock_time_limitfloat

the maximum elapsed clock time allowed (-ve means infinite).

remove_dependenciesbool

the equality constraints will be preprocessed to remove any linear dependencies if True.

treat_zero_bounds_as_generalbool

any problem bound with the value zero will be treated as if it were a general value if True.

treat_separable_as_generalbool

if just_feasible is True, the algorithm will stop as soon as a feasible point is found. Otherwise, the optimal solution to the problem will be found.

just_feasiblebool

if treat_separable_as_general, is True, any separability in the problem structure will be ignored.

getduabool

if getdua, is True, advanced initial values are obtained for the dual variables.

puiseuxbool

decide between Puiseux and Taylor series approximations to the arc.

every_orderbool

try every order of series up to series_order?.

feasolbool

if feasol is True, the final solution obtained will be perturbed so that variables close to their bounds are moved onto these bounds.

balance_initial_complentaritybool

if balance_initial_complentarity is True, the initial complemetarity is required to be balanced.

crossoverbool

if crossover is True, cross over the solution to one defined by linearly-independent constraints if possible.

reduced_pounce_systembool

if reduced_pounce_system is True, eliminate fixed variables when solving the linear system required by the attempted pounce to the solution

space_criticalbool

if space_critical is True, every effort will be made to use as little space as possible. This may result in longer computation time.

deallocate_error_fatalbool

if deallocate_error_fatal is True, any array/pointer deallocation error will terminate execution. Otherwise, computation will continue.

generate_sif_filebool

if generate_sif_file is True, a SIF file describing the current problem is to be generated.

generate_qplib_filebool

if generate_qplib_file is True, a QPLIB file describing the current problem is to be generated.

sif_file_namestr

name of generated SIF file containing input problem.

qplib_file_namestr

name of generated QPLIB file containing input problem.

prefixstr

all output lines will be prefixed by the string contained in quotes within prefix, e.g. ‘word’ (note the qutoes) will result in the prefix word.

fdc_optionsdict

default control options for FDC (see fdc.initialize).

sls_optionsdict

default control options for SLS (see sls.initialize).

sls_pounce_optionsdict

default control options for the SLS pounce (see sls.initialize).

fit_optionsdict

default control options for FIT (see fit.initialize).

roots_optionsdict

default control options for ROOTS (see roots.initialize).

cro_optionsdict

default control options for CRO (see cro.initialize).

clls.load(n, o, m, Ao_type, Ao_ne, Ao_row, Ao_col, Ao_ptr_ne, Ao_ptr, A_type, A_ne, A_row, A_col, A_ptr_ne, A_ptr, options=None)

Import problem data into internal storage prior to solution.

Parameters:

nint

holds the number of variables.

oint

holds the number of residuals.

mint

holds the number of general linear constraints.

Ao_typestring

specifies the unsymmetric storage scheme used for the objective design matrix \(A_o\). It should be one of ‘coordinate’, ‘sparse_by_rows’, ‘sparse_by_columns’, ‘dense’ or ‘dense_by_columns’; lower or upper case variants are allowed.

Ao_neint

holds the number of entries in \(A_o\) in the sparse co-ordinate storage scheme. It need not be set for any of the other schemes.

Ao_rowndarray(Ao_ne)

holds the row indices of \(A_o\) in the sparse co-ordinate and and sparse column-wise storage schemes. It need not be set for any of the other schemes, and in this case can be None.

Ao_colndarray(Ao_ne)

holds the column indices of \(A_o\) in either the sparse co-ordinate, or the sparse row-wise storage scheme. It need not be set for any of the other schemes, and in this case can be None.

Ao_ptr_neint

holds the length of the pointer array if sparse row or column storage scheme is used for \(A_o\). For the sparse row scheme, Ao_ptr_ne should be at least o+1, while for the sparse column scheme, it should be at least n+1, It need not be set when the other schemes are used.

Ao_ptrndarray(Ao_ptr_ne)

holds the starting position of each row of \(A_o\), as well as the total number of entries, in the sparse row-wise storage scheme. By contrast, it holds the starting position of each column of \(A_o\), as well as the total number of entries, in the sparse column-wise storage scheme. It need not be set when the other schemes are used, and in this case can be None.

A_typestring

specifies the unsymmetric storage scheme used for the constraint Jacobian \(A\). It should be one of ‘coordinate’, ‘sparse_by_rows’, ‘sparse_by_columns’, ‘dense’ or ‘dense_by_columns’; lower or upper case variants are allowed.

A_neint

holds the number of entries in \(A\) in the sparse co-ordinate storage scheme. It need not be set for any of the other schemes.

A_rowndarray(A_ne)

holds the row indices of \(A\) in the sparse co-ordinate and and sparse column-wise storage schemes. It need not be set for any of the other schemes, and in this case can be None.

A_colndarray(A_ne)

holds the column indices of \(A\) in either the sparse co-ordinate, or the sparse row-wise storage scheme. It need not be set for any of the other schemes, and in this case can be None.

A_ptr_neint

holds the length of the pointer array if sparse row or column storage scheme is used for \(A\). For the sparse row scheme, A_ptr_ne should be at least m+1, while for the sparse column scheme, it should be at least n+1, It need not be set when the other schemes are used.

A_ptrndarray(A_ptr_ne)

holds the starting position of each row of \(A\), as well as the total number of entries, in the sparse row-wise storage scheme. By contrast, it holds the starting position of each column of \(A\), as well as the total number of entries, in the sparse column-wise storage scheme. It need not be set when the other schemes are used, and in this case can be None.

optionsdict, optional

dictionary of control options (see clls.initialize).

clls.solve_clls(n, o, m, Ao_ne, Ao_val, b, sigma, A_ne, A_val, c_l, c_u, x_l, x_u, x, y, z, w)

Find a solution to the constrained (regularized) linear least-squares problem.

Parameters:

nint

holds the number of variables.

oint

holds the number of residuals.

mint

holds the number of general linear constraints.

Ao_neint

holds the number of entries in the objective design matrix \(A_o\).

Ao_valndarray(Ao_ne)

holds the values of the nonzeros in \(A_o\) in the same order as specified in the sparsity pattern in clls.load.

bndarray(m)

holds the values of the linear term \(g\) in the objective function.

sigmafloat

holds the regularization weight \(\sigma \geq 0\).

A_neint

holds the number of entries in the constraint Jacobian \(A\).

A_valndarray(A_ne)

holds the values of the nonzeros in the constraint Jacobian \(A\) in the same order as specified in the sparsity pattern in clls.load.

c_lndarray(m)

holds the values of the lower bounds \(c_l\) on the constraints The lower bound on any component of \(A x\) that is unbounded from below should be set no larger than minus options.infinity.

c_undarray(m)

holds the values of the upper bounds \(c_l\) on the constraints The upper bound on any component of \(A x\) that is unbounded from above should be set no smaller than options.infinity.

x_lndarray(n)

holds the values of the lower bounds \(x_l\) on the variables. The lower bound on any component of \(x\) that is unbounded from below should be set no larger than minus options.infinity.

x_undarray(n)

holds the values of the upper bounds \(x_l\) on the variables. The upper bound on any component of \(x\) that is unbounded from above should be set no smaller than options.infinity.

xndarray(n)

holds the initial estimate of the minimizer \(x\), if known. This is not crucial, and if no suitable value is known, then any value, such as \(x=0\), suffices and will be adjusted accordingly.

yndarray(m)

holds the initial estimate of the Lagrange multipliers \(y\) associated with the general constraints, if known. This is not crucial, and if no suitable value is known, then any value, such as \(y=0\), suffices and will be adjusted accordingly.

zndarray(n)

holds the initial estimate of the dual variables \(z\) associated with the simple bound constraints, if known. This is not crucial, and if no suitable value is known, then any value, such as \(z=0\), suffices and will be adjusted accordingly.

wndarray(o)

holds the positive regularization weights \(w\). If unit weights are to be used, this can be replaced by None.

Returns:

xndarray(n)

holds the values of the approximate minimizer \(x\) after a successful call.

rndarray(o)

holds the values of the residuals \(r(x) = A_ox-b\).

cndarray(m)

holds the values of the residuals \(c(x) = Ax\).

yndarray(m)

holds the values of the Lagrange multipliers associated with the general linear constraints.

zndarray(n)

holds the values of the dual variables associated with the simple bound constraints.

c_statndarray(m)

holds the return status for each constraint. The i-th component will be negative if the value of the \(i\)-th constraint \((Ax)_i\)) lies on its lower bound, positive if it lies on its upper bound, and zero if it lies between bounds.

x_statndarray(n)

holds the return status for each variable. The i-th component will be negative if the \(i\)-th variable lies on its lower bound, positive if it lies on its upper bound, and zero if it lies between bounds.

[optional] clls.information()

Provide optional output information

Returns:

informdict

dictionary containing output information:

statusint

return status. Possible values are:

• 0

  The run was successful.

• -1

  An allocation error occurred. A message indicating the offending array is written on unit options[‘error’], and the returned allocation status and a string containing the name of the offending array are held in inform[‘alloc_status’] and inform[‘bad_alloc’] respectively.

• -2

  A deallocation error occurred. A message indicating the offending array is written on unit options[‘error’] and the returned allocation status and a string containing the name of the offending array are held in inform[‘alloc_status’] and inform[‘bad_alloc’] respectively.

• -3

  The restriction n > 0 or m > 0 or requirement that type contains its relevant string ‘dense’, ‘coordinate’, ‘sparse_by_rows’, ‘diagonal’, ‘scaled_identity’, ‘identity’, ‘zero’ or ‘none’ has been violated.

• -4

  The bound constraints are inconsistent.

• -5

  The constraints appear to have no feasible point.

• -7

  The objective function appears to be unbounded from below on the feasible set.

• -9

  The analysis phase of the factorization failed; the return status from the factorization package is given by inform[‘factor_status’].

• -10

  The factorization failed; the return status from the factorization package is given by inform[‘factor_status’].

• -11

  The solution of a set of linear equations using factors from the factorization package failed; the return status from the factorization package is given by inform[‘factor_status’].

• -16

  The problem is so ill-conditioned that further progress is impossible.

• -18

  Too many iterations have been performed. This may happen if options[‘maxit’] is too small, but may also be symptomatic of a badly scaled problem.

• -19

  The CPU time limit has been reached. This may happen if options[‘cpu_time_limit’] is too small, but may also be symptomatic of a badly scaled problem.

alloc_statusint

the status of the last attempted allocation/deallocation.

bad_allocstr

the name of the array for which an allocation/deallocation error occurred.

iterint

the total number of iterations required.

factorization_statusint

the return status from the factorization.

factorization_integerlong

the total integer workspace required for the factorization.

factorization_reallong

the total real workspace required for the factorization.

nfactsint

the total number of factorizations performed.

nbactsint

the total number of “wasted” function evaluations during the linesearch.

threadsint

the number of threads used.

objfloat

the value of the objective function at the best estimate of the solution determined by CLLS_solve.

primal_infeasibilityfloat

the value of the primal infeasibility.

dual_infeasibilityfloat

the value of the dual infeasibility.

complementary_slacknessfloat

the value of the complementary slackness.

init_primal_infeasibilityfloat

these values at the initial point (needed by cclls).

init_dual_infeasibilityfloat

see init_primal_infeasibility.

init_complementary_slacknessfloat

see init_primal_infeasibility.

non_negligible_pivotfloat

the smallest pivot which was not judged to be zero when detecting linear dependent constraints.

feasiblebool

is the returned “solution” feasible?.

checkpointsIterndarray(16)

checkpointsIter(i) records the iteration at which the criticality measures first fall below \(10^{-i-1}, i = 0, \ldots 15\) (where -1 means not achieved).

checkpointsTimendarray(16)

checkpointsTime(i) records the CPU time at which the criticality measures first fall below \(10^{-i-1}, i = 0, \ldots 15\) (where -1 means not achieved).

timedict

dictionary containing timing information:

totalfloat

the total CPU time spent in the package.

preprocessfloat

the CPU time spent preprocessing the problem.

find_dependentfloat

the CPU time spent detecting linear dependencies.

analysefloat

the CPU time spent analysing the required matrices prior to factorization.

factorizefloat

the CPU time spent factorizing the required matrices.

solvefloat

the CPU time spent computing the search direction.

clock_totalfloat

the total clock time spent in the package.

clock_preprocessfloat

the clock time spent preprocessing the problem.

clock_find_dependentfloat

the clock time spent detecting linear dependencies.

clock_analysefloat

the clock time spent analysing the required matrices prior to factorization.

clock_factorizefloat

the clock time spent factorizing the required matrices.

clock_solvefloat

the clock time spent computing the search direction.

fdc_informdict

inform parameters for FDC (see fdc.information).

sls_informdict

inform parameters for SLS (see sbls.information).

sls_pounce_informdict

inform parameters for the SLS pounce (see sbls.information).

fit_informdict

return information from FIT (see fit.information).

roots_informdict

return information from ROOTS (see roots.information).

cro_informdict

inform parameters for CRO (see cro.information).

rpd_informdict

inform parameters for RPD (see rpd.information).

clls.terminate()

Deallocate all internal private storage.

example code

from galahad import clls
import numpy as np
np.set_printoptions(precision=4,suppress=True,floatmode='fixed')
print("\n** python test: clls")

# set parameters
n = 3
o = 4
m = 2
infinity = float("inf")

#  describe objective function

b = np.array([2.0,2.0,3.0,1.0])
Ao_type = 'coordinate'
Ao_ne = 7
Ao_row = np.array([0,0,1,1,2,2,3])
Ao_col = np.array([0,1,1,2,0,2,1])
Ao_ptr = None
Ao_val = np.array([1.0,1.0,1.0,1.0,1.0,1.0,1.0])

#  describe constraints

A_type = 'coordinate'
A_ne = 4
A_row = np.array([0,0,1,1])
A_col = np.array([0,1,1,2])
A_ptr = None
A_val = np.array([2.0,1.0,1.0,1.0])
c_l = np.array([1.0,2.0])
c_u = np.array([2.0,2.0])
x_l = np.array([-1.0,-infinity,-infinity])
x_u = np.array([1.0,infinity,2.0])

sigma = 1.0
w = np.array([1.0,1.0,1.0,2.0])

# allocate internal data and set default options
options = clls.initialize()

# set some non-default options
options['print_level'] = 0
#print("options:", options)

# load data (and optionally non-default options)
clls.load(n, o, m, Ao_type, Ao_ne, Ao_row, Ao_col, 0, Ao_ptr,
          A_type, A_ne, A_row, A_col, 0, A_ptr, options)

#  provide starting values (not crucial)

x = np.array([0.0,0.0,0.0])
y = np.array([0.0,0.0])
z = np.array([0.0,0.0,0.0])

# find optimum of clls
print("\n problem: solve clls")
x, r, c, y, z, x_stat, c_stat \
  = clls.solve_clls(n, o, m, Ao_ne, Ao_val, b, sigma, A_ne, A_val,
                    c_l, c_u, x_l, x_u, x, y, z, w)
print(" x:",x)
print(" r:",r)
print(" c:",c)
print(" y:",y)
print(" z:",z)
print(" x_stat:",x_stat)
print(" c_stat:",c_stat)

# get information
inform = clls.information()
print(" f: %.4f" % inform['obj'])

# deallocate internal data

clls.terminate()

This example code is available in $GALAHAD/src/clls/Python/test_clls.py .