/*----------------------------
 Ingeneue source code
 ?Copyright 2000 by George von Dassow, Eli Meir, Edwin Munro, and Garrett Odell.
 Permission is granted for use by private individuals and by individuals and groups at all
 non-profit institutions, as long as those using the software or examining the code
 do not intend to make a profit from its use, and subject to all other conditions
 given on the website www.ingenenue.org.

 www.ingeneue.org
 contact@ingeneue.org
 ----------------------------*/
/**
 Holds all the components of a model, including the network and the cells. This
 class also knows how to load and construct a model from a stream (using the NetInput
 class), and knows how to save a model to a stream.
 */

package main;

import affectors.Affector;
import genegui.GuiInterface;
import genegui.ModelState;
import genegui.ModelStateChangeListener;
import initialconditions.InitialConditionSet;
import java.io.FileOutputStream;
import java.io.PrintWriter;
import java.util.Enumeration;
import parameters.Parameter;
import parameters.ParameterSet;


public class Model extends Object implements ModelStateChangeListener {
	
	
	public final static int              END_OF_RUN = 0;
	public final static int              NEW_RUN = 1;
	public final static int	             UPDATE_CELLS = 2;
	
	/** A ModelState if there is one associated. This is used to communicate
	 changes in the state of the model at the end of runs. */
	private ModelState                   AModelState;
	public int					                 arrayWidth;	// must be even
	public int					                 arrayHeight;
	public int					                 numCells;
	public Cell[]	                       cells = null;
	public	Network				               net = null;
	private InitialConditionSet		       initializers;
	private ParameterSet				         itsParameters;
	public PrintWriter		               out = null;
	
	// These are used while running the model
	private boolean						           good = false;
	
	
	/**
	 Note - after making a new Model, you should immediately call the load() function.
	 Operations using the Model are undefined before load is called and will probably
	 crash. You can check isGood() to see if a model is in a usable state.
	 */
	public Model() {}
	
	public void load(BetterTokenizer tokenizer) throws ModelLoadingException, Exception {
		int		i;
		
		try {
			NetInput input = new NetInput(tokenizer);
			
			net = input.net;
			initializers = input.initializers;
			itsParameters = input.parameters;
			arrayWidth = input.width;
			arrayHeight = input.height;
			
			if((Globals.cellNumSides = input.numsides) == 2)
				arrayHeight = 1;
			
			// Make the cells
			System.out.println("Making cells");
			numCells = arrayWidth * arrayHeight;
			makeCells();
			
			// Arrange connections between neighboring cells
			System.out.println("Attaching neighbors");
			attachNeighbors(Globals.cellNumSides);
			
			// Now that the network and all its nodes has a specific instance in each cell, you can make all the abstract connections
			// into real connections and set intial levels of each node in each cell
			
//			System.out.println("Fixing arrays");
//			Node.fixArrays();		// shrink all node arrays to the right size
			
			// Add in our net to each cell
			System.out.println("Adding nodes to cells");
			for(i = 0; i < numCells; i++) cells[i].addNodes(net);
			
			System.out.println("Adding affectors to cells");
			for(i = 0; i < numCells; i++) cells[i].addAffectors(net);
			
			// After each cell has a copy of the net, connect everything up
//			System.out.println("Connecting affectors");
//			for(i = 0; i < numCells; i++) cells[i].fixAllAffectors(net);
			
			// Set the initial conditions
			System.out.println("Setting initial conditions");
			initializers.setModel(cells);
			good = true;
		} catch(ModelLoadingException e) {
			throw e;
		} catch(Exception e) {
			throw e;
		}
	}
	
	public Network getNetwork() { return net; }
	
	public String getName() { return net.getName(); }
	
	public ParameterSet getModelParameterSet() { return itsParameters; }

	public void setParameterSet(ParameterSet parameters) {
	
		itsParameters = parameters;
		
		Parameter p;
		for (int i=0;i<parameters.getNumParams();i++) {
			p = parameters.getParameter(i);
			Affector.setParamValue(p.getName(),p.getValue());
		}
		
  }
	
	public void setupOutput() {
		// This sets up the output file which will be used to save data from the cells.
		try {
			FileOutputStream file = new FileOutputStream("GeneNetOut.txt");
			out = new PrintWriter(file);
			out.print("Timestep");
			for(int i = 0; i < numCells; i++)
				cells[i].saveHeadings(out);
			out.println();
		} catch(Exception e) {System.out.println(e.toString());}
	}
	
	private void makeCells() {
		int		i, j, index;
		float	sign, x, y;
		
		cells = new Cell[numCells];
		
		Cell.arrayWidth = this.arrayWidth; Cell.arrayHeight = this.arrayHeight;
		
		// First just make each cell, without any attachments or anything.  You need to give the (x,y) position of the cell on the screen
		for(i = 0, y = 1; i < arrayHeight; i++, y += 2f)  {
			index = i * arrayWidth;
			sign = -0.5f;
			
			for(j = 0, x = 1; j < arrayWidth; j++, x += 1.5f) {
				
				if((Globals.cellNumSides == 2) || (Globals.cellNumSides == 4))  {
					cells[index + j] = new Cell(x, y);
					cells[index + j].setItsNum(index + j);
				}
				else  {
					cells[index + j] = new Cell(x, y + sign);
					cells[index + j].setItsNum(index + j);
					sign *= -1;
				}
			}
		}
	}
	
	private void attachNeighbors(int num_sides) {
		int above, below, left, right;
		int	i, j, index;
		
		switch(num_sides) {
			case 2:
				for(j = 0; j < arrayWidth; j++) {
					if((j == 0) && (j == (arrayWidth-1)))  {  // A single cell is it's own neighbor ???
						left = right = 0;
					}
					else if(j == 0)  {  // lies in leftmost column
						left = 1 - arrayWidth;
						right = 1;
					}
					else if(j == (arrayWidth-1))  {  // lies in rightmost column
						left = 1;
						right = 1 - arrayWidth;
					}
					else {  // lies in a center column
						left = 1;
						right = 1;
					}
					
					cells[j].addNeighbor(cells[j - left]);
					cells[j].addNeighbor(cells[j + right]);
				}
				break;
				
			case 4:
				for(i = 0; i < arrayHeight; i++)  {
					index = i * arrayWidth;
					
					if((i == 0) && (i == (arrayHeight-1)))  {  // A single cell is it's own neighbor ???
						above = below = 0;
					}
					else if(i == 0)  {  //  lies along top row
						above = arrayWidth*(arrayHeight - 1);
						below = -arrayWidth;
					}
					else if(i == (arrayHeight-1))  {  // lies along bottom row
						above = - arrayWidth;
						below = arrayWidth*(arrayHeight - 1);
					}
					else {  // lies in a center row
						above = -arrayWidth;
						below = -arrayWidth;
					}
					
					for(j = 0; j < arrayWidth; j++) {
						if((j == 0) && (j == (arrayWidth-1)))  {
							left = right = 0;
						}
						else if(j == 0)  {  // lies in leftmost column
							left = 1 - arrayWidth;
							right = 1;
						}
						else if(j == (arrayWidth-1))  {  // lies in rightmost column
							left = 1;
							right = 1 - arrayWidth;
						}
						else {  // lies in a center column
							left = 1;
							right = 1;
						}
						
						cells[index + j].addNeighbor(cells[index + j + above]);
						cells[index + j].addNeighbor(cells[index + j + right]);
						cells[index + j].addNeighbor(cells[index + j - below]);
						cells[index + j].addNeighbor(cells[index + j - left]);
					}
				}
				break;
				
			case 6:
				for(i = 0; i < arrayHeight; i++)  {
					index = i * arrayWidth;
					
					if((i == 0) && (i == (arrayHeight-1)))  {
						above = below = 0;
					}
					else if(i == 0)  {  //  lies along top row
						above = arrayWidth*(arrayHeight - 1);
						below = -arrayWidth;
					}
					else if(i == (arrayHeight-1))  {  // lies along bottom row
						above = - arrayWidth;
						below = arrayWidth*(arrayHeight - 1);
					}
					else {  // lies in a center row
						above = -arrayWidth;
						below = -arrayWidth;
					}
					
					for(j = 0; j < arrayWidth; j++) {
						
						if((j == 0) && (j == (arrayWidth-1)))  {
							left = right = 0;
						}
						else if(j == 0)  {  // lies in leftmost column
							left = 1 - arrayWidth;
							right = 1;
						}
						else if(j == (arrayWidth-1))  {  // lies in rightmost column
							left = 1;
							right = 1 - arrayWidth;
						}
						else {  // lies in a center column
							left = 1;
							right = 1;
						}
						
						if(Math.IEEEremainder(j,2)==0)  {
							cells[index + j].addNeighbor(cells[index + j + above]);
							cells[index + j].addNeighbor(cells[index + j + above + right]);
							cells[index + j].addNeighbor(cells[index + j + right]);
							cells[index + j].addNeighbor(cells[index + j - below]);
							cells[index + j].addNeighbor(cells[index + j - left]);
							cells[index + j].addNeighbor(cells[index + j + above - left]);
						}
						else {
							cells[index + j].addNeighbor(cells[index + j + above]);
							cells[index + j].addNeighbor(cells[index + j + right]);
							cells[index + j].addNeighbor(cells[index + j - below + right]);
							cells[index + j].addNeighbor(cells[index + j - below]);
							cells[index + j].addNeighbor(cells[index + j - below - left]);
							cells[index + j].addNeighbor(cells[index + j - left]);
						}
						
					}
				}
				break;
		}	// end of switch(num_sides)
	}
	
	public void cleanUp() {
		try {
			if(out != null) out.close();
			out = null;
			good = false;	// Its not really bad yet, but presumably will be soon if this function is being called.
		} catch(Exception e) {}
	}
	
	/** Returns the ModelState Object associated with this model
	@return ModelState - The current ModelState. May be null.
	@author WJS
	 */
	public ModelState getModelState() {
		
		return(AModelState);
		
	}
	
	/** Returns the default initial value for this node as given by its initializers object.
	 If there is no default initializer for this node, returns -1. */
	public float getInitialValue(int node) { return initializers.getDefaultInitialValue(node); }
	
	/** Calls setDefaultInitialValue with given parameters in its initializers object. */
	public void setInitialValue(int node, float value) { initializers.setDefaultInitialValue(node, value, cells); }
	
	
	
	public void saveNetworkFile(PrintWriter pw) {
		pw.println("&Model");
		pw.println();
		
		pw.println("&width\t" + arrayWidth);
		pw.println("&height\t" + arrayHeight);
		pw.println("&numsides\t" + Globals.cellNumSides);
		pw.println();
		pw.println("&Network\t" + net.name);
		pw.println();
		
		pw.println("&Nodes");
		Enumeration nodes_enum = net.getNodes().elements();
		while(nodes_enum.hasMoreElements())
				((NodeTemplate)nodes_enum.nextElement()).toString(pw, "\t");
		pw.println("&endNodes");
		pw.println();
		
		pw.println("&Interactions");
		nodes_enum = net.getNodes().elements();
		while(nodes_enum.hasMoreElements()) {
			NodeTemplate node = (NodeTemplate)nodes_enum.nextElement();
			pw.println("\t&" + node.getName());
			node.affectorsToString(pw, "\t\t");
			pw.println("\t&end" + node.getName());
		}
		pw.println("&endInteractions");
		pw.println();
		
		pw.println("&InitLevels");
		initializers.toString(pw, "\t");
		pw.println("&endInitLevels");
		pw.println();
		
		pw.println("&ParameterValues");
//		ParameterSet fullState = new ParameterSet("fullstate");
		itsParameters.getModel();	// ELI 4/9/01
		itsParameters.toString(pw, "\t");
		pw.println("&endParameterValues");
		pw.println();
		
		pw.println("&endNetwork");
	}
	
	public boolean isGood() { return good; }
	

	/** Sets a ModelState object for this Model. If a ModelState object is set,
	then its values will be updated at the end of each integration step causing
	anything that is listening to it via the ModelStateChangeListener interface
	to be updated
	@param ModelState state - A model state.
	@author WJS
	 */
	public void setModelState(ModelState state) {
		
		AModelState = state;
		state.addModelStateChangeListener(this);
		
	}
	
	public void updateOutput(int type) {
		
		// If there is a ModelState object associated with the the Model, update
		// its values and cause its listeners to update.
		if (AModelState!=null) {
			switch (type) {
				case UPDATE_CELLS:
			    AModelState.updateModel(this,Globals.time);
					break;
				case NEW_RUN:
					GeneNet.TheMainGui.runStatus(GuiInterface.MODEL_STARTED);
					break;
				case END_OF_RUN:
					GeneNet.TheMainGui.runStatus(GuiInterface.MODEL_STOPPED);
					break;
			}
		}
				
	}

	/**************** ModelStateChangeListener implementation *******************/
	
  /** Indicates that the entire ModelState has been updated
	 @author WJS
	 */
	public void updateAll() {
		
	}
	
	/** Updates only the indicated node.
	@param int cellIndex - The index of the cell with the node to be changed.
	@param int nodeIndex - The index of the node to be changed.
	@param float value - Thhe new value for the node.
	 */
	public void updateNode(int cellIndex, int nodeIndex, float value) {
		
		cells[cellIndex].setValue(nodeIndex,value);
		
	}
	
}