jdplus.tramoseats.base.information.ArimaSpecMapping Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdplus-tramoseats-base-information Show documentation
${project.parent.artifactId} - ${project.artifactId}
There is a newer version: 3.2.4
Show newest version
/*
 * Copyright 2020 National Bank of Belgium
 *
 * Licensed under the EUPL, Version 1.2 or – as soon they will be approved 
 * by the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 *
 * https://joinup.ec.europa.eu/software/page/eupl
 *
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and 
 * limitations under the Licence.
 */
package jdplus.tramoseats.base.information;

import jdplus.toolkit.base.api.arima.SarimaSpec;
import jdplus.toolkit.base.api.data.Parameter;
import jdplus.toolkit.base.api.information.InformationSet;
import jdplus.tramoseats.base.api.tramo.MeanSpec;
import jdplus.tramoseats.base.api.tramo.RegressionSpec;

/**
 *
 * @author PALATEJ
 */
@lombok.experimental.UtilityClass
class ArimaSpecMapping {

    static final String MEAN = "mean", MU = "mu", PERIOD = "period",
            THETA = "theta", D = "d", PHI = "phi",
            BTHETA = "btheta", BD = "bd", BPHI = "bphi";

//    static void fillDictionary(String prefix, Map dic) {
//        dic.put(InformationSet.item(prefix, MEAN), Boolean.class);
//        dic.put(InformationSet.item(prefix, MU), Parameter.class);
//        dic.put(InformationSet.item(prefix, D), Integer.class);
//        dic.put(InformationSet.item(prefix, BD), Integer.class);
//        dic.put(InformationSet.item(prefix, THETA), Parameter[].class);
//        dic.put(InformationSet.item(prefix, PHI), Parameter[].class);
//        dic.put(InformationSet.item(prefix, BTHETA), Parameter[].class);
//        dic.put(InformationSet.item(prefix, BPHI), Parameter[].class);
//    }
//
    SarimaSpec read(InformationSet info) {
        if (info == null) {
            return SarimaSpec.airline();
        }
        SarimaSpec.Builder builder = SarimaSpec.builder();
        readProperties(info, builder);
        return builder.build();
    }

    InformationSet write(SarimaSpec spec, boolean verbose) {
        if (SarimaSpec.airline().equals(spec)) {
            return null;
        }
        InformationSet info = new InformationSet();
        writeProperties(info, spec, verbose);
        return info;
    }

    private void readProperties(InformationSet info, SarimaSpec.Builder ab) {
        // default values
        Integer period = info.get(PERIOD, Integer.class);
        if (period != null) {
            ab.period(period);
        }
        Integer d = info.get(D, Integer.class);
        if (d != null) {
            ab.d(d);
        }
        Integer bd = info.get(BD, Integer.class);
        if (bd != null) {
            ab.bd(bd);
        }
        ab.phi(info.get(PHI, Parameter[].class))
                .theta(info.get(THETA, Parameter[].class))
                .bphi(info.get(BPHI, Parameter[].class))
                .btheta(info.get(BTHETA, Parameter[].class));
    }

    private void writeProperties(InformationSet info, SarimaSpec spec, boolean verbose) {
        Parameter[] phi = spec.getPhi();
        int period = spec.getPeriod();
        if (verbose || period != 0) {
            info.set(PERIOD, period);
        }
        if (phi.length > 0) {
            info.set(PHI, phi);
        }
        int d = spec.getD();
        if (verbose || d != 0) {
            info.set(D, d);
        }
        Parameter[] th = spec.getTheta();
        if (th.length > 0) {
            info.set(THETA, th);
        }
        Parameter[] bphi = spec.getBphi();
        if (bphi.length > 0) {
            info.set(BPHI, bphi);
        }
        int bd = spec.getBd();
        if (verbose || bd != 0) {
            info.set(BD, bd);
        }
        Parameter[] bth = spec.getBtheta();
        if (bth.length > 0) {
            info.set(BTHETA, bth);
        }
    }

    // For compatibility issues, ARIMA contains mean correction
    void readLegacy(InformationSet info, SarimaSpec.Builder ab, RegressionSpec.Builder rb) {
        ab.airline();
        readProperties(info, ab);

        // mean
        Boolean mean = info.get(MEAN, Boolean.class);
        if (mean != null) {
            rb.mean(MeanSpec.DEFAULT_USED);
        }
        Parameter m = info.get(MU, Parameter.class);
        if (m != null) {
            rb.mean(MeanSpec.mean(m));
        }
    }

    // For compatibility issues, ARIMA contains mean correction
    InformationSet writeLegacy(SarimaSpec aspec, RegressionSpec rspec, boolean verbose) {
        InformationSet info = new InformationSet();

        // mean
        MeanSpec mu = rspec.getMean();
        if (mu.isUsed()) {
            info.set(MU, mu.getCoefficient());
        }
        writeProperties(info, aspec, verbose);
        return info;

    }

}