Skip to content

cagpjax.policies.base

Classes:

AbstractBatchLinearSolverPolicy

Bases: AbstractLinearSolverPolicy, ABC

Abstract base class for policies that product action matrices.

Methods:

  • to_actions –

    Compute all actions used to solve the linear system \(Ax=b\).

Attributes:

  • n_actions (int) –

    Number of actions in this policy.

n_actions abstractmethod property 

n_actions: int

Number of actions in this policy.

to_actions abstractmethod 

to_actions(A: LinearOperator) -> LinearOperator

Compute all actions used to solve the linear system \(Ax=b\).

For a matrix \(A\) with shape (n, n), the action matrix has shape (n, n_actions).

Parameters:

  • A

    (LinearOperator) –

    Linear operator representing the linear system.

Returns:

Source code in src/cagpjax/policies/base.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
@abc.abstractmethod
def to_actions(self, A: LinearOperator) -> LinearOperator:
    r"""Compute all actions used to solve the linear system $Ax=b$.

    For a matrix $A$ with shape ``(n, n)``, the action matrix has shape
    ``(n, n_actions)``.

    Args:
        A: Linear operator representing the linear system.

    Returns:
        Linear operator representing the action matrix.
    """
    ...

AbstractLinearSolverPolicy

Bases: Module

Abstract base class for all linear solver policies.

Policies define actions used to solve a linear system \(A x = b\), where \(A\) is a square linear operator.