bregman package

Subpackages

• bregman.application package
  • Subpackages
    • bregman.application.distribution package
      • Subpackages
      • Submodules
      • bregman.application.distribution.distribution module
      • Module contents
    • bregman.application.psd package
      • Submodules
      • bregman.application.psd.psd module
      • Module contents
  • Submodules
  • bregman.application.application module
    • ApplicationManifold
      • ApplicationManifold.convert_to_display()
  • Module contents
• bregman.ball package
  • Submodules
  • bregman.ball.base module
    • Ball
      • Ball.is_in()
      • Ball.parametrized_curve()
  • bregman.ball.bregman module
    • BregmanBall
      • BregmanBall.is_in()
    • bregman_badoiu_clarkson()
  • bregman.ball.parameterized module
    • KL2DBregmanBallCurve
      • KL2DBregmanBallCurve.path()
  • Module contents
• bregman.barycenter package
  • Submodules
  • bregman.barycenter.base module
    • ApproxBarycenter
      • ApproxBarycenter.barycenter()
    • Barycenter
      • Barycenter.barycenter()
  • bregman.barycenter.bregman module
    • BregmanBarycenter
      • BregmanBarycenter.barycenter()
    • DualApproxBarycenter
    • DualBarycenter
    • SkewBurbeaRaoBarycenter
      • SkewBurbeaRaoBarycenter.barycenter()
  • Module contents
• bregman.dissimilarity package
  • Submodules
  • bregman.dissimilarity.base module
    • ApproxDissimilarity
      • ApproxDissimilarity.dissimilarity()
    • Dissimilarity
      • Dissimilarity.dissimilarity()
  • bregman.dissimilarity.bregman module
    • BregmanDivergence
      • BregmanDivergence.dissimilarity()
    • ChernoffInformation
      • ChernoffInformation.chernoff_point()
      • ChernoffInformation.dissimilarity()
    • DualApproxDissimilarity
    • DualDissimilarity
    • JeffreysDivergence
      • JeffreysDivergence.dissimilarity()
    • SkewBurbeaRaoDivergence
      • SkewBurbeaRaoDivergence.dissimilarity()
    • SkewJensenBregmanDivergence
      • SkewJensenBregmanDivergence.dissimilarity()
  • Module contents
• bregman.manifold package
  • Submodules
  • bregman.manifold.bisector module
    • Bisector
      • Bisector.bisect_proj_point()
      • Bisector.shift()
    • BregmanBisector
      • BregmanBisector.bisect_proj_point()
      • BregmanBisector.shift()
  • bregman.manifold.connection module
    • Connection
      • Connection.christoffel_first_kind()
      • Connection.cubic()
      • Connection.metric()
    • FlatConnection
      • FlatConnection.christoffel_first_kind()
      • FlatConnection.cubic()
      • FlatConnection.metric()
  • bregman.manifold.coordinate module
    • Atlas
      • Atlas.add_coords()
      • Atlas.add_transition()
      • Atlas.convert_coord()
    • UnrecordedCoordConversion
    • UnrecordedCoordType
  • bregman.manifold.generator module
    • AutoDiffGenerator
      • AutoDiffGenerator.F()
      • AutoDiffGenerator.grad()
      • AutoDiffGenerator.hess()
    • Generator
      • Generator.F()
      • Generator.bregman_divergence()
      • Generator.grad()
      • Generator.hess()
  • bregman.manifold.geodesic module
    • BregmanGeodesic
      • BregmanGeodesic.path()
    • Geodesic
  • bregman.manifold.manifold module
    • BregmanManifold
      • BregmanManifold.bregman_connection()
      • BregmanManifold.bregman_generator()
      • BregmanManifold.convert_coord()
    • EtaGeneratorNotAssigned
  • Module contents
• bregman.object package
  • Submodules
  • bregman.object.distribution module
    • Distribution
      • Distribution.pdf()
  • Module contents
• bregman.visualizer package
  • Subpackages
    • bregman.visualizer.matplotlib package
      • Submodules
      • bregman.visualizer.matplotlib.callback module
      • bregman.visualizer.matplotlib.matplotlib module
      • Module contents
  • Submodules
  • bregman.visualizer.visualizer module
    • BregmanVisualizer
      • BregmanVisualizer.add_callback()
      • BregmanVisualizer.animate_geodesic()
      • BregmanVisualizer.animate_object()
      • BregmanVisualizer.plot_bisector()
      • BregmanVisualizer.plot_geodesic()
      • BregmanVisualizer.plot_object()
      • BregmanVisualizer.plot_point()
      • BregmanVisualizer.run_callbacks()
      • BregmanVisualizer.visualize()
    • NoAnimationRoutine
    • NoPlottingRoutine
    • VisualizerCallback
      • VisualizerCallback.call()
  • Module contents

Submodules

bregman.base module

class bregman.base.BregmanObject

Bases: object

Abstract object used to identify pyBregMan objects. Utilized in identifying objects which can be potentially visualized.

class bregman.base.CoordObject(coords: Coords)

Bases: BregmanObject

Object in pyBregMan which have coordinate type attached to the object. Typically associated with something geometrically defined in a specific coordinate system.

Parameters:

coords – Coordinate type that the object is defined in.

coords: Coords

class bregman.base.Coords(coords_name: str)

Bases: object

Coordinate class. Used to define different types of coordinates utilized by BregmanManifolds.

Parameters:

coords_name – Name of the defined coordinate type.

coords_name: str

class bregman.base.Curve

Bases: BregmanObject, ABC

Abstract curve object.

Parameterization is assumed to be defined for t in [0, 1].

abstract path(t: float) → Point

Curve evaluated at t.

Parameters:

t – Value in [0, 1] corresponding to the parameterization of the curve.

Returns:

Curve evaluated at t.

class bregman.base.DisplayPoint(point: Point)

Bases: ABC, Point

Specialized point class which has additional pretty printing options.

abstract display() → str

Generated pretty printed string on display.

Returns:

String representing point.

class bregman.base.DualCoords(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Coordinate type specific for the dually flat coordinates of Bregman manifolds. Mainly used to restrict coordinate type specification for geometric object definitions when they are only defined for the \(\theta\)- / \(\eta\)-coordinates.

Parameters:

• THETA – \(\theta\)-coordinates.

• ETA – \(\eta\)-coordinates.

ETA = Coords(coords_name='eta')

THETA = Coords(coords_name='theta')

dual()

Calculate dual / opposite type for current dual type.

Returns:

Return the dual of the current coordinate.

class bregman.base.Point(coords: Coords, data: ndarray)

Bases: CoordObject

Basic class corresponding to points on a manifold. A point has data defined in a specific coordinate type / system.

Parameters:

data – Data of point in the specified coordinate type.

data: ndarray

bregman.constants module

Module contents