Source code for figaro.decorators

from figaro.transform import transform_from_probit, transform_to_probit

"""
A gentle introduction to decorators: https://towardsdatascience.com/how-to-use-decorators-in-python-by-example-b398328163b
"""


[docs]
def antiprobit(func):
    """
    Transform a point x from probit space to natural space and returns the function evaluated at the natural point y
    """
    def f_transf(ref, x, *args, **kwargs):
        if not ref.probit:
            return func(ref, x, *args, **kwargs)
        y = transform_from_probit(x, ref.bounds)
        return func(ref, y, *args, **kwargs)
    return f_transf



[docs]
def probit(func):
    """
    Transform a point x from natural space to probit space and returns the function evaluated at the probit point y
    """
    def f_transf(ref, x, *args, **kwargs):
        if not ref.probit:
            return func(ref, x, *args, **kwargs)
        y = transform_to_probit(x, ref.bounds)
        return func(ref, y, *args, **kwargs)
    return f_transf



[docs]
def from_probit(func):
    """
    Evaluate a function that samples points in probit space and return these points after transforming them to natural space
    """
    def f_transf(ref, *args, **kwargs):
        if not ref.probit:
            return func(ref, *args, **kwargs)
        y = func(ref, *args, **kwargs)
        return transform_from_probit(y, ref.bounds)
    return f_transf