TransportMaps.Maps.Decomposable.SequentialInferenceMapFactoryBase

Module Contents

Classes

SequentialInferenceMapFactory	Abstract factory for maps.
SequentialInferenceMapListFactory	Abstract factory for lists of maps.
IncreasingOrderSequentialInferenceMapListFactory	A factory for a list of maps with increasing order.
FadingIncreasingOrderSequentialInferenceMapListFactory	The orders are scaled down using the following formula:

class TransportMaps.Maps.Decomposable.SequentialInferenceMapFactoryBase.SequentialInferenceMapFactory(*args, **kwargs)

Bases: TransportMaps.Maps.MapFactory

Abstract factory for maps.

It provides a function MapFactory.generate() which returns the generated map.

abstract generate(nsteps, *args, **kwargs)

[abstract] generates maps.

Parameters:

nsteps (int) – number of sequential steps the maps should for

class TransportMaps.Maps.Decomposable.SequentialInferenceMapFactoryBase.SequentialInferenceMapListFactory(n_maps, *args, **kwargs)

Bases: TransportMaps.Maps.MapListFactory, SequentialInferenceMapFactory

Abstract factory for lists of maps.

It provides a function MapFactory.generate() which returns the generated list of maps.

abstract generate(nsteps, *args, **kwargs)

[abstract] generates maps.

Parameters:

nsteps (int) – number of sequential steps the maps should for

class TransportMaps.Maps.Decomposable.SequentialInferenceMapFactoryBase.IncreasingOrderSequentialInferenceMapListFactory(max_order, btype='fun')

Bases: SequentialInferenceMapListFactory

A factory for a list of maps with increasing order.

property max_order

property btype

class TransportMaps.Maps.Decomposable.SequentialInferenceMapFactoryBase.FadingIncreasingOrderSequentialInferenceMapListFactory(max_order, btype='fun', alpha=0.0)

Bases: IncreasingOrderSequentialInferenceMapListFactory

The orders are scaled down using the following formula:

\[q_d = \lfloor q^{1/(1+\alpha d)} \rceil\]

where \(q\) is the maximum order in the current map and \(\alpha\) tunes the speed at which the order decrease to \(1\) with respect to \(d\). With \(\alpha=0\) the order is not decreased.

Parameters:

alpha (float) – \(alpha\)

property alpha