/*
 * Copyright (c) 2003-onwards Shaven Puppy Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'Shaven Puppy' nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package worm.path;

import java.io.Serializable;

/**
 * Our nodes
 */
class Node implements Serializable {

	private static final long serialVersionUID = 1L;

//	/** Whether this node came from the pool */
//	boolean fromPool;
//
//	/** Whether we should be in the pool or not */
//	boolean pooled;

	/** used during the search to record the parent of successor nodes */
	Node parent;

	/** used after the search for the application to view the search in reverse */
	Node child;

	/** cost of this node + it's predecessors */
	int g;

	/** heuristic estimate of distance to goal */
	int h;

	/** sum of cumulative cost of predecessors and self and heuristic */
	int f;

	/** Binary heap index */
	int heapIdx;

	/** User state (packed X Y coordinate) */
	int userState;

	Node(int userState, Node parent) {
		this.userState = userState;
		this.parent = parent;
	}

	@Override
	public boolean equals(Object obj) {
		return ((Node) obj).userState == this.userState;
	}

	@Override
	public int hashCode() {
		return userState;
	}

	@Override
	public String toString() {
		return "Node["+userState+", f="+f+", g="+g+", h="+h+"]";
	}

}