Skip to main content

operator_function

Overloads

NameDescription
operator_function(const ComplexMatrix matrix, const ComplexFunctionWithDeriv fun) -> ObjectApproximates a matrix function using the Krylov subspace method.
operator_function(const ComplexMatrix matrix, const Function<complex(complex)> fun) -> ObjectApproximates a matrix function using the Krylov subspace method.
operator_function(const RealMatrix matrix, const Function<real(real)> fun) -> ObjectApproximates a matrix function using the Krylov subspace method.
operator_function(const ComplexMatrix matrix, const Function<complex(complex)> fun, const Map opts) -> ObjectApproximates a matrix function using the Krylov subspace method.
operator_function(const RealMatrix matrix, const Function<real(real)> fun, const Map opts) -> ObjectApproximates a matrix function using the Krylov subspace method.
operator_function(const ComplexMatrix matrix, const ComplexFunctionWithDeriv fun, const Map opts) -> ObjectApproximates a matrix function using the Krylov subspace method.

operator_function(const ComplexMatrix matrix, const ComplexFunctionWithDeriv fun) -> Object

Approximates a matrix function using the Krylov subspace method.

This function is accepts non-Hermitian matrices. The scalar function signature should be (complex, integer) -> complex. Options are provided as a map of option names to their values.

Parameters

  • matrix: The matrix to wrap.
  • fun: A scalar function corresponding to the matrix function.

operator_function(const ComplexMatrix matrix, const Function<complex(complex)> fun) -> Object

Approximates a matrix function using the Krylov subspace method.

This function accepts Hermitian matrices. Options are provided as a map of option names to their values.

Parameters

  • matrix: The matrix to wrap.
  • fun: A scalar function corresponding to the matrix function.

operator_function(const RealMatrix matrix, const Function<real(real)> fun) -> Object

Approximates a matrix function using the Krylov subspace method.

This function accepts Hermitian matrices. Options are provided as a map of option names to their values.

Parameters

  • matrix: The matrix to wrap.
  • fun: A scalar function corresponding to the matrix function.

operator_function(const ComplexMatrix matrix, const Function<complex(complex)> fun, const Map opts) -> Object

Approximates a matrix function using the Krylov subspace method.

This function accepts Hermitian matrices. Options are provided as a map of option names to their values.

Parameters

  • matrix: The matrix to wrap.
  • fun: A scalar function corresponding to the matrix function.
  • opts: Options for the operator function.
    • is_real (boolean): Indicates whether the function is real-valued. This option is required to correctly handle real-valued functions.
    • krylov_dimension (integer): The dimension of the Krylov subspace (default: 2 * nev + 2). This parameter must be larger than nev. If convergence issues are encountered, increasing this value may help.

operator_function(const RealMatrix matrix, const Function<real(real)> fun, const Map opts) -> Object

Approximates a matrix function using the Krylov subspace method.

This function accepts Hermitian matrices. Options are provided as a map of option names to their values.

Parameters

  • matrix: The matrix to wrap.
  • fun: A scalar function corresponding to the matrix function.
  • opts: Options for the operator function.
    • is_real (boolean): Indicates whether the function is real-valued. This option is required to correctly handle real-valued functions.
    • krylov_dimension (integer): The dimension of the Krylov subspace (default: 2 * nev + 2). This parameter must be larger than nev. If convergence issues are encountered, increasing this value may help.

operator_function(const ComplexMatrix matrix, const ComplexFunctionWithDeriv fun, const Map opts) -> Object

Approximates a matrix function using the Krylov subspace method.

This function is accepts non-Hermitian matrices. The scalar function signature should be (complex, integer) -> complex. Options are provided as a map of option names to their values.

Parameters

  • matrix: The matrix to wrap.
  • fun: A scalar function corresponding to the matrix function.
  • opts: Options for the operator function.
    • is_real (boolean): Indicates whether the function is real-valued. This option is required to correctly handle real-valued functions.
    • krylov_dimension (integer): The dimension of the Krylov subspace (default: 2 * nev + 2). This parameter must be larger than nev. If convergence issues are encountered, increasing this value may help.