examples_signal.py

# imports

# standard

import random

# local, external

# local, internal

import src.topupopt.problems.esipp.signal as signal

# ******************************************************************************
# ******************************************************************************


def examples():
    # **************************************************************************
    # **************************************************************************

    # test creating fixed signals

    example_fixed_signals()

    # test creating free signals

    example_free_signals()

    # test creating bounded signals

    example_bounded_signals()

    # test setting a signal

    example_set_signal()

    # test non-negative reals

    example_nnr_signals()

    # test binary signals

    example_binary_signals()

    # trigger errors that can only happen by messing with private/interval vars

    example_peculiar_errors()

    # test amplitude constrained signals

    example_amplitude_constrained_signals()

    # test amplitude constrained non-negative real signals

    example_amplitude_constrained_nnr_signals()

    # **************************************************************************
    # **************************************************************************


# ******************************************************************************
# ******************************************************************************


def example_amplitude_constrained_nnr_signals():
    # number of time intervals

    number_intervals = 3

    # **************************************************************************

    # error-free examples

    # create signal with max positive amplitude limit

    sig = signal.AmplitudeConstrainedNNRSignal(
        number_samples=number_intervals,
        max_pos_amp_limit=10,
        min_pos_amp_limit=None,
    )

    assert not sig.has_max_neg_amp_limit
    assert not sig.has_min_neg_amp_limit
    assert sig.has_max_pos_amp_limit
    assert not sig.has_min_pos_amp_limit
    assert sig.is_signal_bounded()
    assert not sig.is_signal_fixed()

    # create signal with min positive amplitude limit

    sig = signal.AmplitudeConstrainedNNRSignal(
        number_samples=number_intervals,
        max_pos_amp_limit=None,
        min_pos_amp_limit=3,
    )

    assert not sig.has_max_neg_amp_limit
    assert not sig.has_min_neg_amp_limit
    assert not sig.has_max_pos_amp_limit
    assert sig.has_min_pos_amp_limit
    assert sig.is_signal_bounded()
    assert not sig.is_signal_fixed()

    # create signal with positive constraints only

    sig = signal.AmplitudeConstrainedNNRSignal(
        number_samples=number_intervals,
        max_pos_amp_limit=10,
        min_pos_amp_limit=3,
    )

    assert not sig.has_max_neg_amp_limit
    assert not sig.has_min_neg_amp_limit
    assert sig.has_max_pos_amp_limit
    assert sig.has_min_pos_amp_limit
    assert sig.is_signal_bounded()
    assert not sig.is_signal_fixed()

    # **************************************************************************

    # trigger errors

    # by providing a non-numeric nr. of samples without specific lower bounds

    error_was_raised = False
    try:
        sig = signal.AmplitudeConstrainedNNRSignal(
            number_samples=(number_intervals,), max_pos_amp_limit=10
        )
    except TypeError:
        error_was_raised = True
    assert error_was_raised

    # by providing negative lower bounds

    error_was_raised = False
    try:
        sig = signal.AmplitudeConstrainedNNRSignal(
            number_samples=number_intervals,
            max_pos_amp_limit=10,
            lower_bounds=[-1 for i in range(number_intervals)],
        )
    except ValueError:
        error_was_raised = True
    assert error_was_raised


# ******************************************************************************
# ******************************************************************************


def example_amplitude_constrained_signals():
    # number of time intervals

    number_intervals = 3

    # **************************************************************************

    # error-free examples

    # create signal with max positive amplitude limit

    sig = signal.AmplitudeConstrainedSignal(
        number_samples=number_intervals,
        max_pos_amp_limit=10,
        min_pos_amp_limit=None,
        max_neg_amp_limit=None,
        min_neg_amp_limit=None,
    )

    assert not sig.has_max_neg_amp_limit
    assert not sig.has_min_neg_amp_limit
    assert sig.has_max_pos_amp_limit
    assert not sig.has_min_pos_amp_limit
    assert not sig.is_signal_bounded()
    assert not sig.is_signal_fixed()
    sig.set_positive_amplitude(positive_amplitude=5)
    sig.validate_positive_amplitude()
    # use the tolerances and validate an otherwise invalid amplitude
    sig.set_positive_amplitude(positive_amplitude=12)
    sig.validate_positive_amplitude(tolerance=2)

    # create signal with min positive amplitude limit

    sig = signal.AmplitudeConstrainedSignal(
        number_samples=number_intervals,
        max_pos_amp_limit=None,
        min_pos_amp_limit=3,
        max_neg_amp_limit=None,
        min_neg_amp_limit=None,
    )

    assert not sig.has_max_neg_amp_limit
    assert not sig.has_min_neg_amp_limit
    assert not sig.has_max_pos_amp_limit
    assert sig.has_min_pos_amp_limit
    assert not sig.is_signal_bounded()
    assert not sig.is_signal_fixed()
    sig.set_positive_amplitude(positive_amplitude=5)
    sig.validate_positive_amplitude()