# -*- coding: utf-8 -*-
# ######### COPYRIGHT #########
# Credits
# #######
#
# Copyright(c) 2015-2025
# ----------------------
#
# * `LabEx Archimède <http://labex-archimede.univ-amu.fr/>`_
# * `Laboratoire d'Informatique Fondamentale <http://www.lif.univ-mrs.fr/>`_
#   (now `Laboratoire d'Informatique et Systèmes <http://www.lis-lab.fr/>`_)
# * `Institut de Mathématiques de Marseille <http://www.i2m.univ-amu.fr/>`_
# * `Université d'Aix-Marseille <http://www.univ-amu.fr/>`_
#
# This software is a port from LTFAT 2.1.0 :
# Copyright (C) 2005-2025 Peter L. Soendergaard <peter@sonderport.dk>.
#
# Contributors
# ------------
#
# * Denis Arrivault <contact.dev_AT_lis-lab.fr>
# * Florent Jaillet <contact.dev_AT_lis-lab.fr>
#
# Description
# -----------
#
# ltfatpy is a partial Python port of the
# `Large Time/Frequency Analysis Toolbox <http://ltfat.sourceforge.net/>`_,
# a MATLAB®/Octave toolbox for working with time-frequency analysis and
# synthesis.
#
# Version
# -------
#
# * ltfatpy version = 1.1.2
# * LTFAT version = 2.1.0
#
# Licence
# -------
#
# This program 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.
#
# 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# ######### COPYRIGHT #########


"""Test of the phaselock function

.. moduleauthor:: Florent Jaillet
"""

from __future__ import print_function, division

import unittest
import numpy as np
from numpy.testing import assert_allclose

from ltfatpy.gabor.phaselock import phaselock
from ltfatpy.gabor.phaseunlock import phaseunlock
from ltfatpy.gabor.dgt import dgt
from ltfatpy.tests.datasets.read_ref_mat import read_ref_mat
from ltfatpy.tests.datasets.get_dataset_path import get_dataset_path

# NOTE: The reference values used in the tests correspond to results
# obtained with Octave using ltfat 2.1.0


class TestPhaselock(unittest.TestCase):

    # Called before the tests.
    def setUp(self):
        print('\nStart TestPhaselock')

    # Called after the tests.
    def tearDown(self):
        print('Test done')

    def test_exceptions(self):
        """Check that the right exceptions are raised when expected
        """
        c = dgt(np.random.random((16,)), 'gauss', 2, 6)[0]
        # a is expected to be an integer, check that we get type error if not
        self.assertRaises(TypeError, phaselock, c, 'test')
        self.assertRaises(TypeError, phaselock, c, 1.0)
        self.assertRaises(TypeError, phaselock, c, (1, 2))
        # a should be the value used to generate c with dgt, check that we get
        # a value error if not
        self.assertRaises(ValueError, phaselock, c, 3)

    def test_known(self):
        """Check phaselock on some known results taken from Octave
        """
        filename = get_dataset_path('phaselock_ref.mat')
        data = read_ref_mat(filename)

        for inputs, outputs in data:
            out = phaselock(**inputs)
            msg = ('Wrong output in phaselock with inputs ' +
                   str(inputs))
            assert_allclose(out, outputs[0], rtol=1e-15, err_msg=msg)

    def test_inverse(self):
        """Check that phaselock and phaseunlock are inverse functions
        """
        shapes = ((3, 3), (12, 6), (13, 13))
        a_val = (1, 4, 7)
        inputs = {}
        for shape, a in zip(shapes, a_val):
            inputs['c'] = np.random.random(shape)
            inputs['a'] = a
            msg = ('phaselock and phaseunlock should be inverse with inputs ' +
                   str(inputs))
            out = phaseunlock(phaselock(**inputs), inputs['a'])
            assert_allclose(inputs['c'], out, rtol=1e-15, err_msg=msg)
            out = phaselock(phaseunlock(**inputs), inputs['a'])
            assert_allclose(inputs['c'], out, rtol=1e-15, err_msg=msg)


if __name__ == '__main__':
    suite = unittest.TestLoader().loadTestsFromTestCase(TestPhaselock)
    unittest.TextTestRunner(verbosity=2).run(suite)