com.meliorbis.economics.model.State Maven / Gradle / Ivy

Go to download

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

A library for solving economic models, particularly macroeconomic models with heterogeneous agents who have model-consistent expectations

There is a newer version: 1.1

Show newest version

/**
 * 
 */
package com.meliorbis.economics.model;

import java.util.Map;

import com.meliorbis.economics.individual.IndividualProblemState;
import com.meliorbis.economics.infrastructure.AggregateProblemState;
import com.meliorbis.numerics.convergence.Criterion;
import com.meliorbis.numerics.generic.primitives.DoubleArray;

/**
 * Holds the state of the calculation whilst a model is being solved and simulated
 * 
 * @author Tobias Grasl
 * 
 * @param  The configuration type used with this State's Model
 */
public interface State extends IndividualProblemState, 
	AggregateProblemState
{	
	/**
	 * Increments the count of periods that have been solved
	 */
	void incrementPeriod();
	
	/**
	 * @return The period we are in
	 */
	int getPeriod();
	
	/**
	 * Passes a map of arrays by name that should be set
	 * 
	 * @param arraysByName_ The arrays to be set
	 */
	void setNamedArrays(Map> arraysByName_);
	

	/**
	 * Returns the criterion that the Solver will check against the target
	 * value to determine whether the solution has converged
	 * 
	 * @return The criterion
	 */
	Criterion getConvergenceCriterion();

    /**
     * @return The model being calculated which this state is for
     */
    C getConfig();
}