operator_free

Overloads

Name	Description
operator_free(const ComplexSparseMatrix matrix) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const RealMatrix matrix) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const Operator operator) -> Operator	Generates an operator that represents the hopping terms of the input operator.
operator_free(const ComplexMatrix matrix) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const RealSparseMatrix matrix) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const RealSparseMatrix matrix, as_real options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const RealSparseMatrix matrix, as_complex options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const ComplexSparseMatrix matrix, const StateInfo options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const ComplexMatrix matrix, const StateInfo options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const ComplexMatrix matrix, as_real options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const ComplexMatrix matrix, as_complex options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const ComplexSparseMatrix matrix, as_real options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const RealMatrix matrix, const StateInfo options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const RealMatrix matrix, as_complex options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const RealMatrix matrix, as_real options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const RealSparseMatrix matrix, const StateInfo options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.
operator_free(const Operator operator_sum, const StateInfo options) -> Operator	Generates an operator that represents the hopping terms of the input operator.
operator_free(const Operator operator_sum, as_real options) -> Operator	Generates an operator that represents the hopping terms of the input operator.
operator_free(const Operator operator_sum, as_complex options) -> Operator	Generates an operator that represents the hopping terms of the input operator.
operator_free(const ComplexSparseMatrix matrix, as_complex options) -> Operator	Generates an operator that represents the hopping terms of the input matrix.

operator_free(const ComplexSparseMatrix matrix) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the free operator.

operator_free(const RealMatrix matrix) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the free operator.

operator_free(const Operator operator) -> Operator

Generates an operator that represents the hopping terms of the input operator.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• operator: The operator representing a sum of hopping terms.

operator_free(const ComplexMatrix matrix) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the free operator.

operator_free(const RealSparseMatrix matrix) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the free operator.

operator_free(const RealSparseMatrix matrix, as_real options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const RealSparseMatrix matrix, as_complex options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const ComplexSparseMatrix matrix, const StateInfo options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const ComplexMatrix matrix, const StateInfo options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const ComplexMatrix matrix, as_real options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const ComplexMatrix matrix, as_complex options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const ComplexSparseMatrix matrix, as_real options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const RealMatrix matrix, const StateInfo options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const RealMatrix matrix, as_complex options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const RealMatrix matrix, as_real options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const RealSparseMatrix matrix, const StateInfo options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.

operator_free(const Operator operator_sum, const StateInfo options) -> Operator

Generates an operator that represents the hopping terms of the input operator.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• operator_sum: The operator sum.
• options: A set of options used to dispatch the appropriate operator.

operator_free(const Operator operator_sum, as_real options) -> Operator

Generates an operator that represents the hopping terms of the input operator.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• operator_sum: The operator sum.
• options: A set of options used to dispatch the appropriate operator.

operator_free(const Operator operator_sum, as_complex options) -> Operator

Generates an operator that represents the hopping terms of the input operator.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• operator_sum: The operator sum.
• options: A set of options used to dispatch the appropriate operator.

operator_free(const ComplexSparseMatrix matrix, as_complex options) -> Operator

Generates an operator that represents the hopping terms of the input matrix.

Unless specified otherwise, using the factory operator_free on an operator will default to complex. Valid options include (as_real, as_complex, unspecified) | (as_fermion, unspecified) | (as_singleparticle, unspecified) | (as_sparse, unspecified) and will default to (as_complex | as_fermion | as_singleparticle | as_sparse) respectively. When used on a matrix, the scalar field defaults to that of the provided matrix unless specified otherwise.

Parameters

• matrix: The matrix representation of the single-particle operator.
• options: A set of options used to specify the single particle operator type.