.. currentmodule:: mutwo.core_utilities

mutwo.core_utilities
====================

.. contents:: Table of content
   :depth: 3

.. automodule:: mutwo.core_utilities
   :members:


.. list-table::
   :width: 95%
   :header-rows: 1

   * - Object
     - Documentation
   * - :class:`mutwo.core_utilities.add_copy_option`
     - This decorator adds a copy option for object mutating methods.
   * - :class:`mutwo.core_utilities.add_tag_to_class`
     - This decorator adds a 'tag' argument to the init method of a class.
   * - :class:`mutwo.core_utilities.compute_lazy`
     - Cache function output to disk via pickle.
   * - :class:`mutwo.core_utilities.AlreadyDefinedValueNameError`
     - 
   * - :class:`mutwo.core_utilities.InvalidAverageValueStartAndEndWarning`
     - 
   * - :class:`mutwo.core_utilities.InvalidStartValueError`
     - 
   * - :class:`mutwo.core_utilities.InvalidPointError`
     - 
   * - :class:`mutwo.core_utilities.ImpossibleToSquashInError`
     - 
   * - :class:`mutwo.core_utilities.InvalidStartAndEndValueError`
     - 
   * - :class:`mutwo.core_utilities.InvalidCutOutStartAndEndValuesError`
     - 
   * - :class:`mutwo.core_utilities.SplitUnavailableChildError`
     - 
   * - :class:`mutwo.core_utilities.NoSolutionFoundError`
     - 
   * - :class:`mutwo.core_utilities.factorise`
     - factorise(integer) -> [list of factors]
   * - :class:`mutwo.core_utilities.factors`
     - Get factor generator
   * - :class:`mutwo.core_utilities.is_prime`
     - Test if number is prime or not.
   * - :class:`mutwo.core_utilities.scale`
     - Scale a value from one range to another range.
   * - :class:`mutwo.core_utilities.scale_sequence_to_sum`
     - Scale numbers in a sequence so that the resulting sum fits to the given value.
   * - :class:`mutwo.core_utilities.accumulate_from_n`
     - Accumulates iterable starting with value n.
   * - :class:`mutwo.core_utilities.accumulate_from_zero`
     - Accumulates iterable starting from 0.
   * - :class:`mutwo.core_utilities.insert_next_to`
     - Insert an item into a list relative to the first item equal to a certain value.
   * - :class:`mutwo.core_utilities.uniqify_sequence`
     - Not-Order preserving function to uniqify any iterable with non-hashable objects.
   * - :class:`mutwo.core_utilities.cyclic_permutations`
     - Cyclic permutation of an iterable. Return a generator object.
   * - :class:`mutwo.core_utilities.find_closest_index`
     - Return index of element in ``data`` with smallest difference to ``item``.
   * - :class:`mutwo.core_utilities.find_closest_item`
     - Return element in ``data`` with smallest difference to ``item``.
   * - :class:`mutwo.core_utilities.get_nested_item_from_index_sequence`
     - Get item in nested Sequence.
   * - :class:`mutwo.core_utilities.set_nested_item_from_index_sequence`
     - Set item in nested Sequence.
   * - :class:`mutwo.core_utilities.find_numbers_which_sums_up_to`
     - Find all combinations of numbers which sum is equal to the given sum.
   * - :class:`mutwo.core_utilities.call_function_except_attribute_error`
     - Run a function with argument as input
   * - :class:`mutwo.core_utilities.round_floats`
     - Round number if it is an instance of float, otherwise unaltered number.
   * - :class:`mutwo.core_utilities.camel_case_to_snake_case`
     - Transform camel case formatted string to snake case.
   * - :class:`mutwo.core_utilities.test_if_objects_are_equal_by_parameter_tuple`
     - Check if the parameters of two objects have equal values.
   * - :class:`mutwo.core_utilities.get_all`
     - Fetch from all arguments their `__all__` attribute and combine them to one tuple




.. autofunction:: add_copy_option
    


.. autofunction:: add_tag_to_class
    


.. autofunction:: compute_lazy
    


.. autofunction:: factorise
    


.. autofunction:: factors
    


.. autofunction:: is_prime
    


.. autofunction:: scale
    


.. autofunction:: scale_sequence_to_sum
    


.. autofunction:: accumulate_from_n
    


.. autofunction:: accumulate_from_zero
    


.. autofunction:: insert_next_to
    


.. autofunction:: uniqify_sequence
    


.. autofunction:: cyclic_permutations
    


.. autofunction:: find_closest_index
    


.. autofunction:: find_closest_item
    


.. autofunction:: get_nested_item_from_index_sequence
    


.. autofunction:: set_nested_item_from_index_sequence
    


.. autofunction:: find_numbers_which_sums_up_to
    


.. autofunction:: call_function_except_attribute_error
    


.. autofunction:: round_floats
    


.. autofunction:: camel_case_to_snake_case
    


.. autofunction:: test_if_objects_are_equal_by_parameter_tuple
    


.. autofunction:: get_all
    

.. autoclass:: mutwo.core_utilities.AlreadyDefinedValueNameError

        .. autoclasstoc::
    

.. autoclass:: mutwo.core_utilities.InvalidAverageValueStartAndEndWarning

        .. autoclasstoc::
    

.. autoclass:: mutwo.core_utilities.InvalidStartValueError

        .. autoclasstoc::
    

.. autoclass:: mutwo.core_utilities.InvalidPointError

        .. autoclasstoc::
    

.. autoclass:: mutwo.core_utilities.ImpossibleToSquashInError

        .. autoclasstoc::
    

.. autoclass:: mutwo.core_utilities.InvalidStartAndEndValueError

        .. autoclasstoc::
    

.. autoclass:: mutwo.core_utilities.InvalidCutOutStartAndEndValuesError

        .. autoclasstoc::
    

.. autoclass:: mutwo.core_utilities.SplitUnavailableChildError

        .. autoclasstoc::
    

.. autoclass:: mutwo.core_utilities.NoSolutionFoundError

        .. autoclasstoc::
    


mutwo.core_utilities.configurations
-----------------------------------

.. automodule:: mutwo.core_utilities.configurations
   :members: