core.utils.parameters

Parameters operations utils module

gridr.core.utils.parameters.tuplify(p, ndim)

Utility method to convert a single parameter to a tuple.

If the parameter p is already a sequence (list or tuple), it is returned as is. Otherwise, the output tuple corresponds to the repeated couple (p, p) along each dimension.

For example:

tuplify('a', 3)  # Returns (('a', 'a'), ('a', 'a'), ('a', 'a'))

Parameters:

• p (Any or tuple) – The parameter to tuplify. It can be any single value or an existing sequence.

• ndim (int) – The number of dimensions, which determines how many times (p, p) is repeated if p is not already a sequence.

Returns:

The tuplified parameter. If p was already a sequence, it returns p itself. Otherwise, it returns a tuple of ndim pairs, where each pair is (p, p).

Return type:

Any or tuple