lphy.base.function.RepArray Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lphy-base Show documentation

The standard library of LPhy, which contains the required generative distributions and basic functions.

The newest version!

package lphy.base.function;

import lphy.base.ParameterNames;
import lphy.core.model.DeterministicFunction;
import lphy.core.model.Value;
import lphy.core.model.annotation.GeneratorInfo;
import lphy.core.model.annotation.ParameterInfo;

import java.util.Arrays;

public class RepArray extends DeterministicFunction {

    private final String timesParamName = "n";

    public RepArray(@ParameterInfo(name = ParameterNames.ArrayParamName, description = "1d-array to replicate.") Value x,
                    @ParameterInfo(name = timesParamName, description = "the times to replicate array.") Value times) {

        if (x == null) throw new IllegalArgumentException("The array can't be null!");
        T[] value = x.value();
        if (value == null || value.length < 1)
            throw new IllegalArgumentException("Must have at least 1 element in the array!");

        if (times == null) throw new IllegalArgumentException("The times can't be null!");

        setParam(ParameterNames.ArrayParamName, x);
        setParam(timesParamName, times);
    }

    @GeneratorInfo(name = "repArray", description = "The replication function. " +
            "Take an array and an integer representing the number of times to replicate the array. " +
            "Return a vector of the value repeated the specified number of times.")
    public Value apply() {
        T[] origArr = (T[]) getParams().get(ParameterNames.ArrayParamName).value();
        int t = (int) getParams().get(timesParamName).value();
        T[] array = Arrays.copyOf(origArr, origArr.length * t);
        for (int i = 1; i < t; i++) {
            System.arraycopy(origArr, 0, array, origArr.length * i, origArr.length);
        }

        return new Value<>( null, array, this);
    }
}