skimpy.utils.tensor
===================

.. py:module:: skimpy.utils.tensor

.. autoapi-nested-parse::

   .. module:: skimpy
      :platform: Unix, Windows
      :synopsis: Simple Kinetic Models in Python

   .. moduleauthor:: SKiMPy team

   [---------]

   Copyright 2017 Laboratory of Computational Systems Biotechnology (LCSB),
   Ecole Polytechnique Federale de Lausanne (EPFL), Switzerland

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.



Attributes
----------

.. autoapisummary::

   skimpy.utils.tensor.sample_ix


Classes
-------

.. autoapisummary::

   skimpy.utils.tensor.Tensor


Module Contents
---------------

.. py:class:: Tensor(data, indexes, *args, **kwargs)

   Bases: :py:obj:`object`


   .. py:attribute:: _data


   .. py:attribute:: complementary_indexes


   .. py:attribute:: _i


   .. py:attribute:: _j


   .. py:attribute:: _k


   .. py:method:: build_index_dict(index_names)


   .. py:method:: slice_by(slicer, value)

      Returns a slice of the tensor along a value on a specific index

      :param slicer:
      :type slicer: str or pandas.Index
      :param value:
      :return:



   .. py:method:: get_slice_index(slicer)

      Utility function for getting the integer number of the index (0,1, or 2)

      :param slicer:
      :return:



   .. py:method:: mean(slicer, *args, **kwargs)

      Flatten using the mean along an index

      :param slicer:
      :param args:
      :param kwargs:
      :return:



   .. py:method:: std(slicer, *args, **kwargs)

      Flatten using the standard deviation along an index
      :param slicer:
      :param args:
      :param kwargs:
      :return:



   .. py:method:: quantile(slicer, quantile, *args, **kwargs)

      Flatten using the standard deviation along an index
      :param slicer:
      :param args:
      :param kwargs:
      :return:



   .. py:method:: make_df(data, index1, index2)


.. py:data:: sample_ix