File: CHOLMOD_factorization_rcond.docstring

package info (click to toggle)
mrcal 2.5-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 8,444 kB
  • sloc: python: 40,601; ansic: 15,576; cpp: 1,754; perl: 303; makefile: 158; sh: 98; lisp: 84
file content (27 lines) | stat: -rw-r--r-- 838 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Compute rough estimate of reciprocal of condition number

SYNOPSIS

    b, x, J, factorization = \
        mrcal.optimizer_callback(**optimization_inputs)

    rcond = factorization.rcond()

Calls cholmod_rcond(). Its documentation says:

  Returns a rough estimate of the reciprocal of the condition number: the
  minimum entry on the diagonal of L (or absolute entry of D for an LDLT
  factorization) divided by the maximum entry. L can be real, complex, or
  zomplex. Returns -1 on error, 0 if the matrix is singular or has a zero or NaN
  entry on the diagonal of L, 1 if the matrix is 0-by-0, or
  min(diag(L))/max(diag(L)) otherwise. Never returns NaN; if L has a NaN on the
  diagonal it returns zero instead.

ARGUMENTS

- None

RETURNED VALUE

A single floating point value: an estimate of the reciprocal of the condition
number