org.ojalgo.array.StrategyBuildingFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ojalgo Show documentation

oj! Algorithms - ojAlgo - is Open Source Java code that has to do with mathematics, linear algebra and optimisation.

There is a newer version: 55.0.1

package org.ojalgo.array;

import org.ojalgo.structure.Access1D;

public abstract class StrategyBuildingFactory, I extends Access1D, SB extends StrategyBuildingFactory> {

    private final DenseCapacityStrategy myStrategy;

    public StrategyBuildingFactory(final DenseArray.Factory denseFactory) {

        super();

        myStrategy = new DenseCapacityStrategy<>(denseFactory);
    }

    /**
     * @param chunk Defines the capacity break point. Below this point the capacity is doubled when needed.
     *        Above it, it is grown by adding one "chunk" at the time.
     * @return this
     */
    public SB chunk(final long chunk) {
        myStrategy.chunk(chunk);
        return (SB) this;
    }

    public SB fixed(final long fixed) {
        return this.initial(fixed).limit(fixed);
    }

    /**
     * @param initial Sets the initial capacity of the "arrays" to be created using this factory.
     * @return this
     */
    public SB initial(final long initial) {
        myStrategy.initial(initial);
        return (SB) this;
    }

    /**
     * @param limit Defines a maximum size. Only set this if you know the precise max size, and it should be
     *        something relatively small. Setting the max size is meant as an alternative to setting any/all
     *        of the other paramaters, and will switch to a tighter capacity strategy. The only other
     *        configuration you may want to set in combination with this one is the initial capacity (set that
     *        first in that case).
     * @return this
     */
    public SB limit(final long limit) {
        myStrategy.limit(limit);
        return (SB) this;
    }

    public abstract I make();

    DenseCapacityStrategy getStrategy() {
        return myStrategy;
    }

}