.. |DefaultMask| replace:: :class:`~hydpy.core.masktools.DefaultMask`
.. |False| replace:: :const:`False`
.. |InputSequence| replace:: :class:`~hydpy.core.sequencetools.InputSequence`
.. |Masks| replace:: :class:`~hydpy.core.masktools.Masks`
.. |MixinFixedShape| replace:: :class:`~hydpy.core.variabletools.MixinFixedShape`
.. |ModelSequence| replace:: :class:`~hydpy.core.sequencetools.ModelSequence`
.. |Model| replace:: :class:`~hydpy.core.modeltools.Model`
.. |NodeSequence| replace:: :class:`~hydpy.core.sequencetools.NodeSequence`
.. |None| replace:: :const:`None`
.. |Options.trimvariables| replace:: :const:`~hydpy.core.optiontools.Options.trimvariables`
.. |Parameters| replace:: :class:`~hydpy.core.parametertools.Parameters`
.. |Parameter| replace:: :class:`~hydpy.core.parametertools.Parameter`
.. |RuntimeError| replace:: :class:`RuntimeError`
.. |Sequence_| replace:: :class:`~hydpy.core.sequencetools.Sequence_`
.. |Sequences| replace:: :class:`~hydpy.core.sequencetools.Sequences`
.. |SubParameters| replace:: :class:`~hydpy.core.parametertools.SubParameters`
.. |SubSequences| replace:: :class:`~hydpy.core.sequencetools.SubSequences`
.. |SubVariables| replace:: :class:`~hydpy.core.variabletools.SubVariables`
.. |Variable.INIT| replace:: :attr:`~hydpy.core.variabletools.Variable.INIT`
.. |Variable.availablemasks| replace:: :const:`~hydpy.core.variabletools.Variable.availablemasks`
.. |Variable.average_values| replace:: :func:`~hydpy.core.variabletools.Variable.average_values`
.. |Variable.initinfo| replace:: :const:`~hydpy.core.variabletools.Variable.initinfo`
.. |Variable.mask| replace:: :func:`~hydpy.core.variabletools.Variable.mask`
.. |Variable.numberofvalues| replace:: :const:`~hydpy.core.variabletools.Variable.numberofvalues`
.. |Variable.refweights| replace:: :const:`~hydpy.core.variabletools.Variable.refweights`
.. |Variable.shape| replace:: :const:`~hydpy.core.variabletools.Variable.shape`
.. |Variable.values| replace:: :const:`~hydpy.core.variabletools.Variable.values`
.. |Variable.valuevector| replace:: :const:`~hydpy.core.variabletools.Variable.valuevector`
.. |Variable.value| replace:: :const:`~hydpy.core.variabletools.Variable.value`
.. |Variable.verify| replace:: :func:`~hydpy.core.variabletools.Variable.verify`
.. |Variable| replace:: :class:`~hydpy.core.variabletools.Variable`
.. |bool| replace:: :class:`bool`
.. |dict| replace:: :class:`dict`
.. |exch| replace:: :mod:`~hydpy.models.exch`
.. |float| replace:: :class:`float`
.. |get_tolerance| replace:: :func:`~hydpy.core.variabletools.get_tolerance`
.. |hland| replace:: :mod:`~hydpy.models.hland`
.. |id| replace:: :func:`id`
.. |int| replace:: :class:`int`
.. |kinw| replace:: :mod:`~hydpy.models.kinw`
.. |len| replace:: :func:`len`
.. |numpy| replace:: :mod:`~numpy`
.. |parametertools| replace:: :mod:`~hydpy.core.parametertools`
.. |sequencetools| replace:: :mod:`~hydpy.core.sequencetools`
.. |set| replace:: :class:`set`
.. |sort_variables| replace:: :func:`~hydpy.core.variabletools.sort_variables`
.. |to_repr| replace:: :func:`~hydpy.core.variabletools.to_repr`
.. |trim| replace:: :func:`~hydpy.core.variabletools.trim`
.. |tuple| replace:: :class:`tuple`
.. |exch_factors.WaterLevels| replace:: :class:`~hydpy.models.exch.exch_factors.WaterLevels`
.. |hland_sequences.State2DSequence.valuevector| replace:: :const:`~hydpy.models.hland.hland_sequences.State2DSequence.valuevector`
.. |hland_states.SP| replace:: :class:`~hydpy.models.hland.hland_states.SP`
.. |kinw_control.BV| replace:: :class:`~hydpy.models.kinw.kinw_control.BV`
.. |numpy.nan| replace:: :const:`~numpy.nan`
.. |sequencetools.InputSequences| replace:: :class:`~hydpy.core.sequencetools.InputSequences`
.. |sw1d_control.BottomLowWaterThreshold.trim| replace:: :func:`~hydpy.models.sw1d.sw1d_control.BottomLowWaterThreshold.trim`
.. |sw1d_control.BottomLowWaterThreshold| replace:: :class:`~hydpy.models.sw1d.sw1d_control.BottomLowWaterThreshold`

.. _variabletools:

variabletools
=============

.. automodule:: hydpy.core.variabletools
    :members:
    :show-inheritance:
    :exclude-members: Union, AsyncIterable, CONTROLPARAMETERS, TypeAliasType, NotRequired, ADD_METHODS, RESULTSEQUENCES, Protocol, reveal_type, MutableSet, Concatenate, REQUIREDSEQUENCES, SupportsFloat, MutableSequence, SOLVERSEQUENCES, assert_never, NamedTuple, Text, Coroutine, ValuesView, FrozenSet, evaluate_forward_ref, SUBMODELINTERFACES, get_args, get_origin, ForwardRef, INTERFACE_METHODS, Annotated, Mapping, TypeForm, is_protocol, ChainMap, Iterator, TypeGuard, SUBMETHODS, runtime, ParamSpecArgs, SUBMODELS, TypedDict, KeysView, OUTLET_METHODS, Collection, Sequence, CapsuleType, Generator, NoReturn, ParamSpec, TextIO, AsyncContextManager, ContextManager, ParamSpecKwargs, assert_type, UPDATEDSEQUENCES, SupportsIndex, get_annotations, dataclass_transform, no_type_check_decorator, ClassVar, AsyncGenerator, Buffer, TypeIs, SupportsAbs, Match, FULL_ODE_METHODS, Sized, Never, is_typeddict, get_original_bases, TypeVarTuple, no_type_check, FIXEDPARAMETERS, DefaultDict, get_type_hints, NewType, fastaccess_old, Literal, TypeVar, runtime_checkable, ByteString, Format, Deque, Final, deprecated, final, Callable, SENDER_METHODS, Generic, AsyncIterator, Any, RECEIVER_METHODS, fastaccess_new, cast, MappingView, DERIVEDPARAMETERS, Counter, subseqs, List, SupportsComplex, OrderedDict, CLASSES, Unpack, Awaitable, MutableMapping, INLET_METHODS, IntVar, Set, RUN_METHODS, subpars, overload, Doc, Optional, Iterable, AbstractSet, NoExtraItems, TypeAlias, get_protocol_members, ReadOnly, clear_overloads, Type, BinaryIO, Pattern, fastaccess, Container, Hashable, NoDefault, PART_ODE_METHODS, LiteralString, SupportsInt, Self, SupportsBytes, SupportsRound, Dict, SOLVERPARAMETERS, Reversible, pars, Required, Tuple, ItemsView, override, get_overloads, IO, subvars, TYPE_CHECKING, seqs, AnyStr