python-igraph manual

For using igraph from Python

   Home       Trees       Indices       Help   
Package igraph :: Class ARPACKOptions
[hide private]

Class ARPACKOptions

source code

object --+
         |
        ARPACKOptions

Class representing the parameters of the ARPACK module.

ARPACK is a Fortran implementation of the implicitly restarted Arnoldi method, an algorithm for calculating some of the eigenvalues and eigenvectors of a given matrix. igraph uses this package occasionally, and this class can be used to fine-tune the behaviour of ARPACK in such cases.

The class has several attributes which are not documented here, since they are usually of marginal use to the ordinary user. See the source code of the original ARPACK Fortran package (especially the file dsaupd.f) for a detailed explanation of the parameters. Only the most basic attributes are explained here. Most of them are read only unless stated otherwise.

  • bmat: type of the eigenproblem solved. 'I' means standard eigenproblem (A*x = lambda*x), 'G' means generalized eigenproblem (A*x = lambda*B*x).
  • n: dimension of the eigenproblem
  • tol: precision. If less than or equal to zero, the standard machine precision is used as computed by the LAPACK utility called dlamch. This can be modified.
  • mxiter: maximum number of update iterations to take. This can be modified. You can also use maxiter.
  • iter: actual number of update iterations taken
  • numop: total number of OP*x operations
  • numopb: total number of B*x operations if bmat is 'G'
  • numreo: total number of steps of re-orthogonalization
Instance Methods [hide private]
a new object with type S, a subtype of T
__new__(T, S, ...) source code
 
__str__(x)
str(x)
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__new__(T, S, ...)

source code 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__

__str__(x)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__

   Home       Trees       Indices       Help