TransportMaps.Maps.DeprecatedConditionallyLinearMapBase

Module Contents

Classes

ConditionallyLinearMap

Map \(T:\mathbb{R}^{d_x}\times\mathbb{R}^{d_a}\rightarrow\mathbb{R}^{d_y}\) defined by \(T({\bf x};{\bf a}) = {\bf c}({\bf a}) + {\bf T}({\bf a}) {\bf x}\)

class TransportMaps.Maps.DeprecatedConditionallyLinearMapBase.ConditionallyLinearMap(c, T, coeffs=None)[source]

Bases: TransportMaps.Maps.MapBase.Map

Map \(T:\mathbb{R}^{d_x}\times\mathbb{R}^{d_a}\rightarrow\mathbb{R}^{d_y}\) defined by \(T({\bf x};{\bf a}) = {\bf c}({\bf a}) + {\bf T}({\bf a}) {\bf x}\)

Parameters:
  • c (Map) – map \({\bf c}:\mathbb{R}^{d_a}\rightarrow\mathbb{R}^{d_y}\)

  • T (Map) – map \({\bf T}:\mathbb{R}^{d_a}\rightarrow\mathbb{R}^{d_y\times d_x}\)

  • coeffs (ndarray) – fixing the coefficients \({\bf a}\) defining \({\bf c}({\bf a})\) and \({\bf T}({\bf a})\).

property c[source]
property T[source]
property n_coeffs[source]
property dim_lin[source]
property coeffs[source]

Returns the actual value of the coefficients.

Returns:

(ndarray [\(N\)]) – coefficients.

property grad_a_c[source]
property grad_a_T[source]
property hess_a_c[source]
property hess_a_T[source]
evaluate(x, precomp=None, idxs_slice=slice(None))[source]

Evaluate the map \(T\) at the points \({\bf x}\).

Parameters:
  • x (ndarray [\(m,d_x\)]) – evaluation points

  • precomp (dict) – dictionary of precomputed values

  • idxs_slice (slice) – if precomputed values are present, this parameter indicates at which of the points to evaluate. The number of indices represented by idxs_slice must match x.shape[0].

Returns:

(ndarray [\(m,d_y\)]) – transformed points

grad_x(x, precomp=None, idxs_slice=slice(None))[source]

[Abstract] Evaluate the gradient \(\nabla_{\bf x}T\) at the points \({\bf x} \in \mathbb{R}^{m \times d_x}\).

Parameters:
  • x (ndarray [\(m,d_x\)]) – evaluation points

  • precomp (dict) – dictionary of precomputed values

  • idxs_slice (slice) – if precomputed values are present, this parameter indicates at which of the points to evaluate. The number of indices represented by idxs_slice must match x.shape[0].

Returns:

(ndarray [\(m,d_y,d_x\)]) – transformed points

Raises:

NotImplementedError – to be implemented in sub-classes