merlin.utils.normalization module

Shared normalization helpers for amplitudes and probabilities.

merlin.utils.normalization.probabilities_from_amplitudes(amplitudes)

Convert complex amplitudes into probabilities.

Parameters:

amplitudes (torch.Tensor) – Complex amplitude tensor.

Returns:

Probability tensor computed elementwise from amplitudes.

Return type:

torch.Tensor

merlin.utils.normalization.normalize_probabilities(probabilities, computation_space)

Normalize probabilities for computation spaces that require it.

Parameters:
  • probabilities (torch.Tensor) – Probability tensor to normalize.

  • computation_space (ComputationSpace | None) – Computation space that determines whether normalization is required.

Returns:

Normalized probability tensor. For computation spaces that do not require renormalization, the input tensor is returned unchanged.

Return type:

torch.Tensor

merlin.utils.normalization.normalize_probabilities_and_amplitudes(amplitudes, computation_space)

Return probabilities and renormalized amplitudes when required.

Parameters:
  • amplitudes (torch.Tensor) – Complex amplitude tensor.

  • computation_space (ComputationSpace | None) – Computation space that determines whether renormalization is required.

Returns:

Probability tensor and possibly renormalized amplitude tensor.

Return type:

tuple[torch.Tensor, torch.Tensor]