.. lsqfitgp/docs/reference/array.rst
..
.. Copyright (c) 2020, 2022, 2023, Giacomo Petrillo
..
.. This file is part of lsqfitgp.
..
.. lsqfitgp is free software: you can redistribute it and/or modify
.. it under the terms of the GNU General Public License as published by
.. the Free Software Foundation, either version 3 of the License, or
.. (at your option) any later version.
..
.. lsqfitgp is distributed in the hope that it will be useful,
.. but WITHOUT ANY WARRANTY; without even the implied warranty of
.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.. GNU General Public License for more details.
..
.. You should have received a copy of the GNU General Public License
.. along with lsqfitgp.  If not, see <http://www.gnu.org/licenses/>.

.. currentmodule:: lsqfitgp

.. _array:

Structured arrays
=================

Taking derivatives on structured numpy arrays is not supported by `jax`,
so structured arrays are internally wrapped with :class:`StructuredArray`.

.. autoclass:: StructuredArray
    :members: from_dataframe, from_dict

Functions
---------

.. autofunction:: asarray
.. autofunction:: broadcast
.. autofunction:: broadcast_arrays
.. autofunction:: broadcast_to
.. autofunction:: unstructured_to_structured