Source code for gemseo.mlearning.resampling.split

# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# This program 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
"""A train-test split."""

from __future__ import annotations

from dataclasses import dataclass
from typing import TYPE_CHECKING

from numpy import array_equal

if TYPE_CHECKING:
    from numpy.typing import NDArray




@dataclass
class Split:
    """A train-test split."""

    train: NDArray[int]
    """The indices of the train samples."""

    test: NDArray[int]
    """The indices of the test samples."""

    def __eq__(self, other: Split) -> bool:
        return array_equal(self.test, other.test) and array_equal(
            self.train, other.train
        )