Source code for example_simulator_functions.sinus

#
# SPDX-License-Identifier: LGPL-3.0-or-later
# Copyright (c) 2024-2025, QUEENS contributors.
#
# This file is part of QUEENS.
#
# QUEENS is free software: you can redistribute it and/or modify it under the terms of the GNU
# Lesser General Public License as published by the Free Software Foundation, either version 3 of
# the License, or (at your option) any later version. QUEENS 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 QUEENS. If not,
# see <https://www.gnu.org/licenses/>.
#
"""Sine test function."""

import numpy as np




def sinus_test_fun(x1):
    """Evaluate standard sine as a test function.

    Args:
        x1 (float): Input of the sinus in RAD

    Returns:
        result (float): Value of the sinus function
    """
    result = np.sin(x1)
    return result





def gradient_sinus_test_fun(x1):
    """Evaluate sine and its gradient.

    Args:
        x1 (float): Input of the sinus in RAD

    Returns:
        result (float): Value of the sinus function
    """
    result = np.sin(x1)
    gradient = np.cos(x1)
    return result, gradient