bregman.application.psd package

Submodules

bregman.application.psd.psd module

class bregman.application.psd.psd.PSDDualGenerator(dimension: int)

Bases: AutoDiffGenerator

PSD manifold dual Bregman generator.

Parameters:

selector – Exacts indices from matrix to yield vector PSD data.

class bregman.application.psd.psd.PSDManifold(n_dimension: int)

Bases: ApplicationManifold[PSDPoint]

PSD Manifold. Points on the PSD manifold are represented by a minimal set of values. For instance, in the manifold of 2x2 PSD matrices, each point only needs to be represented by 3 values (rather than the full 4 values of the matrix).

class bregman.application.psd.psd.PSDPoint(point: Point)

Bases: DisplayPoint

DisplayPoint type for PSD manifold

property dimension: int

Matrix shape dimension of the PSD data.

Returns:

Matrix shape dimension of the PSD data (i.e, d in dxd PSD matrix).

display() → str

Display string of matrix format of PSD data.

Returns:

Matrix string of PSD data.

property m: ndarray

Calculates matrix representation of PSD data (which is a vector).

Returns:

Matrix format of the PSD data.

class bregman.application.psd.psd.PSDPrimalGenerator(dimension: int)

Bases: AutoDiffGenerator

PSD manifold primal Bregman generator.

Parameters:

selector – Exacts indices from matrix to yield vector PSD data.

bregman.application.psd.psd.psd_data_from_matrices(m: ndarray, dimension: int) → ndarray

Function to convert a PSD matrix into a minimal vector PSD data format.

Parameters:

  • m – PSD matrix.

  • dimension – Shape dimension of the matrix m (i.e, d in dxd PSD matrix).

Returns:

Minimal vector represented a PSD matrix.

bregman.application.psd.psd.psd_data_to_matrices(d: ndarray, dimension: int) → ndarray

Function to convert minimal vector PSD data format into a PSD matrix.

Parameters:

  • d – Minimal PSD vector data.

  • dimension – Shape dimension of the matrix m (i.e, d in dxd PSD matrix).

Returns:

PSD matrix constructed from minimal data.

Module contents