matflow.MultiPathSequence#

class matflow.MultiPathSequence(paths, values, nesting_order=None, label=None, value_class_method=None)#

Bases: MultiPathSequence

A sequence of values to be distributed across one or more paths.

Notes

This is useful when we would like to generate values for multiple input paths that have some interdependency, or when they must be generate together in one go.

Parameters:

  • paths (Sequence[str]) – The paths to this multi-path sequence.

  • values (NDArray | Sequence[Sequence] | None) – The values in this multi-path sequence.

  • nesting_order (int) – A nesting order for this multi-path sequence. Can be used to compose sequences together.

  • label (str) – A label for this multi-path sequence.

  • value_class_method (str) – Name of a method used to generate multi-path sequence values. Not normally used directly.

Methods

from_json_like

Make an instance of this class from JSON (or YAML) data.

from_latin_hypercube

Generate values from SciPy's latin hypercube sampler: scipy.stats.qmc.LatinHypercube.

to_dict

Serialize this object as a dictionary.

to_json_like

Serialize this object as an object structure that can be trivially converted to JSON.

Attributes

sequence_indices

The range indices (start and stop) to the parent element set's sequences list that correspond to the `ValueSequence`s generated by this multi-path sequence, if this object is bound to a parent element set.

sequences

The child value sequences, one for each path.

values

classmethod from_json_like(json_like, shared_data=None)#

Make an instance of this class from JSON (or YAML) data.

Parameters:

  • json_like – The data to deserialise.

  • shared_data – Shared context data.

Return type:

The deserialised object.

classmethod from_latin_hypercube(paths, num_samples, *, scramble=True, strength=1, optimization=None, rng=None, nesting_order=None, label=None)#

Generate values from SciPy’s latin hypercube sampler: scipy.stats.qmc.LatinHypercube.

Parameters:

  • paths (Sequence[str]) –

  • num_samples (int) –

  • scramble (bool) –

  • strength (int) –

  • optimization (Literal['random-cd', 'lloyd'] | None) –

  • nesting_order (int | float | None) –

  • label (str | int | None) –

Return type:

Self

property sequence_indices: Sequence[int] | None#

The range indices (start and stop) to the parent element set’s sequences list that correspond to the `ValueSequence`s generated by this multi-path sequence, if this object is bound to a parent element set.

property sequences: Sequence[ValueSequence]#

The child value sequences, one for each path.

to_dict()#

Serialize this object as a dictionary.

Return type:

dict[str, Any]

to_json_like(dct=None, shared_data=None, exclude=(), path=None)#

Serialize this object as an object structure that can be trivially converted to JSON. Note that YAML can also be produced from the result of this method; it just requires a different final serialization step.

Parameters:

  • dct (dict[str, JSONable] | None) –

  • shared_data (_JSONDeserState) –

  • exclude (Container[str | None]) –

  • path (list | None) –

Return type:

tuple[JSONDocument, _JSONDeserState]

property values: list[Sequence[Any]]#