SciPy 0.6.0 API Documentation Generated by Endo, 2007-10-17

Class SciPy.​linsolve.​umfpack.​umfpack.​UmfpackContext

Contents:
• Base classes
• Methods

Inherits from

• Struct: SciPy.linsolve.umfpack.umfpack.Struct

Method summary

• __call__(self, sys, mtx, rhs, autoTranspose = False)
• __init__(self, family = 'di', **kwargs)
• free(self)
• free_numeric(self)
• free_symbolic(self)
• linsolve(self, sys, mtx, rhs, autoTranspose = False)
• lu(self, mtx)
• numeric(self, mtx)
• report_control(self)
• report_info(self)
• report_numeric(self)
• report_symbolic(self)
• solve(self, sys, mtx, rhs, autoTranspose = False)
• strControl(self)
• strInfo(self)
• symbolic(self, mtx)

Methods

• __call__(self, sys, mtx, rhs, autoTranspose = False)

  Uses solve() or linsolve() depending on the presence of the Numeric
  object.
  
  Arguments:
          sys - one of UMFPACK system description constants, like
                UMFPACK_A, UMFPACK_At, see umfSys list and UMFPACK
                docs
          mtx - sparse matrix (CSR or CSC)
          rhs - right hand side vector
          autoTranspose - automatically changes 'sys' to the
                transposed type, if 'mtx' is in CSR, since UMFPACK
                assumes CSC internally
  

• __init__(self, family = 'di', **kwargs)

  Arguments:

  family .. family of UMFPACK functions ('di', 'dl', 'zi', 'zl')

  Keyword arguments:

  maxCond .. if extimated condition number is greater than maxCond,

  a warning is printed (default: 1e12)

• free(self)
• free_numeric(self)
• free_symbolic(self)
• linsolve(self, sys, mtx, rhs, autoTranspose = False)

  One-shot solution of system of linear equation. Reuses Numeric object
  if possible.
  
  Arguments:
          sys - one of UMFPACK system description constants, like
                UMFPACK_A, UMFPACK_At, see umfSys list and UMFPACK
                docs
          mtx - sparse matrix (CSR or CSC)
          rhs - right hand side vector
          autoTranspose - automatically changes 'sys' to the
                transposed type, if 'mtx' is in CSR, since UMFPACK
                assumes CSC internally
  

• lu(self, mtx)

  Returns an LU decomposition of an m-by-n matrix in the form (L, U, P, Q, R, do_recip):

  L - Lower triangular m-by-min(m,n) CSR matrix U - Upper triangular min(m,n)-by-n CSC matrix P - Vector of row permuations Q - Vector of column permuations R - Vector of diagonal row scalings do_recip - boolean

  For a given matrix A, the decomposition satisfies:

  LU = PRAQ when do_recip is true LU = P(R^-1)AQ when do_recip is false

• numeric(self, mtx)

  Numeric object (LU decomposition) computation using the symbolic decomposition. The symbolic decomposition is (re)computed if necessary.

• report_control(self)

  Print control values.

• report_info(self)

  Print all status information. Output depends on self.control[UMFPACK_PRL].

• report_numeric(self)

  Print information about the numeric object. Output depends on self.control[UMFPACK_PRL].

• report_symbolic(self)

  Print information about the symbolic object. Output depends on self.control[UMFPACK_PRL].

• solve(self, sys, mtx, rhs, autoTranspose = False)

  Solution of system of linear equation using the Numeric object.
  
  Arguments:
          sys - one of UMFPACK system description constants, like
                UMFPACK_A, UMFPACK_At, see umfSys list and UMFPACK
                docs
          mtx - sparse matrix (CSR or CSC)
          rhs - right hand side vector
          autoTranspose - automatically changes 'sys' to the
                transposed type, if 'mtx' is in CSR, since UMFPACK
                assumes CSC internally
  

• strControl(self)
• strInfo(self)
• symbolic(self, mtx)

  Symbolic object (symbolic LU decomposition) computation for a given sparsity pattern.