org.chocosolver.memory.EnvironmentBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of choco-solver Show documentation
Open-source constraint solver.
There is a newer version: 4.10.17
/*
 * This file is part of choco-solver, http://choco-solver.org/
 *
 * Copyright (c) 2023, IMT Atlantique. All rights reserved.
 *
 * Licensed under the BSD 4-clause license.
 *
 * See LICENSE file in the project root for full license information.
 */
package org.chocosolver.memory;

import org.chocosolver.memory.trailing.EnvironmentTrailing;
import org.chocosolver.memory.trailing.trail.*;
import org.chocosolver.memory.trailing.trail.chunck.*;
import org.chocosolver.memory.trailing.trail.flatten.*;

/**
 * 
 * Project: choco-solver.
 *
 * @author Charles Prud'homme
 * @since 10/05/2016.
 */
public class EnvironmentBuilder {

    /**
     * The maximum numbers of worlds that a
     * {@link org.chocosolver.memory.IStorage} can handle.
     */
    private int worldnumber = EnvironmentTrailing.NBWORLDS;

    /**
     * The maximum numbers of updates that a
     * {@link org.chocosolver.memory.IStorage} can handle.
     */
    private int worldsize = EnvironmentTrailing.NBUPATES;

    /**
     * The load factor to update {@link org.chocosolver.memory.IStorage}.
     */
    private double loadfactor = EnvironmentTrailing.LOADFACTOR;

    /**
     * Trail to consider to manage doubles
     */
    private IStoredDoubleTrail dt;
    /**
     * Trail to consider to manage booleans
     */
    private IStoredBoolTrail bt;
    /**
     * Trail to consider to manage integers
     */
    private IStoredIntTrail it;
    /**
     * Trail to consider to manage longs
     */
    private IStoredLongTrail lt;
    /**
     * Trail to consider to manage operations
     */
    private IOperationTrail ot;

    /**
     * The maximum numbers of updates that a
     * {@link org.chocosolver.memory.IStorage} can handle.
     * @param ws maximum numbers
     * @return {@code this}
     */
    public EnvironmentBuilder setWorldSize(int ws){
        worldsize = ws;
        return this;
    }

    /**
     * The maximum numbers of worlds that a
     * {@link org.chocosolver.memory.IStorage} can handle.
     * @param wn maximum numbers
     * @return {@code this}
     */
    public EnvironmentBuilder setWorldNumber(int wn){
        worldnumber = wn;
        return this;
    }

    /**
     * The load factor to update {@link org.chocosolver.memory.IStorage}.
     * @param lf load factor
     * @return {@code this}
     */
    public EnvironmentBuilder setLoadfactor(double lf){
        loadfactor = lf;
        return this;
    }


    /**
     * Set the int trail.
     * @param t the trail to use
     * @return {@code this}
     */
    public EnvironmentBuilder setTrail(IStoredIntTrail t) {
        it = t;
        return this;
    }

    /**
     * Set the long trail.
     * @param t the trail to use
     * @return {@code this}
     */
    public EnvironmentBuilder setTrail(IStoredLongTrail t) {
        lt = t;
        return this;
    }

    /**
     * Set the double trail.
     * @param t the trail to use
     * @return {@code this}
     */
    public EnvironmentBuilder setTrail(IStoredDoubleTrail t) {
        dt = t;
        return this;
    }

    /**
     * Set the bool trail.
     * @param t the trail to use
     * @return {@code this}
     */
    public EnvironmentBuilder setTrail(IStoredBoolTrail t) {
        bt = t;
        return this;
    }

    /**
     * Set the operation trail.
     * @param t the trail to use
     * @return {@code this}
     */
    public EnvironmentBuilder setTrail(IOperationTrail t) {
        ot = t;
        return this;
    }

    /**
     * Build the environment
     * @return the resulting environment
     */
    public EnvironmentTrailing build(){
        EnvironmentTrailing env = new EnvironmentTrailing();
        if (bt == null) {
            bt = new StoredBoolTrail(worldsize, worldnumber, loadfactor);
        }

        if (it == null) {
            it = new StoredIntTrail(worldsize, worldnumber, loadfactor);
        }

        if (dt == null) {
            dt = new StoredDoubleTrail(worldsize, worldnumber, loadfactor);
        }

        if (lt == null) {
            lt = new StoredLongTrail(worldsize, worldnumber, loadfactor);
        }

        if (ot == null) {
            ot = new OperationTrail(worldsize, worldnumber, loadfactor);
        }

        env.setBoolTrail(bt);
        env.setIntTrail(it);
        env.setDoubleTrail(dt);
        env.setOperationTrail(ot);
        env.setLongTrail(lt);
        return env;
    }

    /**
     * Build a chunk environment
     * @return {@code this}
     */
    public EnvironmentBuilder fromChunk(){
        setTrail(new ChunckedBoolTrail(worldsize, worldnumber, loadfactor));
        setTrail(new ChunckedIntTrail(worldsize, worldnumber, loadfactor));
        setTrail(new ChunckedDoubleTrail(worldsize, worldnumber, loadfactor));
        setTrail(new ChunckedLongTrail(worldsize, worldnumber, loadfactor));
        setTrail(new ChunckedOperationTrail(worldsize, worldnumber, loadfactor));
        return this;
    }

    /**
     * Build a flat environment
     * @return the resulting environment
     */
    public EnvironmentBuilder fromFlat(){
        setTrail(new StoredBoolTrail(worldsize, worldnumber, loadfactor));
        setTrail(new StoredIntTrail(worldsize, worldnumber, loadfactor));
        setTrail(new StoredDoubleTrail(worldsize, worldnumber, loadfactor));
        setTrail(new StoredLongTrail(worldsize, worldnumber, loadfactor));
        setTrail(new OperationTrail(worldsize, worldnumber, loadfactor));
        return this;
    }
}