coordax.new_axis_name¶

coordax.new_axis_name(field: Field, excluded_names: set[str] | None = None) → str[source]¶

Returns axis name that is not present in field or excluded_names.

Parameters:

field – The field to generate a new axis name for.
excluded_names – Optional set of names to exclude.

Returns:

A new axis name.

Examples

>>> import coordax as cx
>>> import jax.numpy as jnp
>>> field = cx.field(jnp.zeros((2, 3)))
>>> field2 = field.tag(cx.new_axis_name(field), ...)
>>> field2
<Field dims=('axis_0', None) shape=(2, 3) axes={} >
>>> field3 = field2.tag(cx.new_axis_name(field2))
>>> field3
<Field dims=('axis_0', 'axis_1') shape=(2, 3) axes={} >