TreeNode.java

/*
 * Encog(tm) Core v3.4 - Java Version
 * http://www.heatonresearch.com/encog/
 * https://github.com/encog/encog-java-core
 
 * Copyright 2008-2016 Heaton Research, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *   
 * For more information on Heaton Research copyrights, licenses 
 * and trademarks visit:
 * http://www.heatonresearch.com/copyright
 */
package org.encog.ml.tree;

import java.util.List;

/**
 * A node for a tree.
 */
public interface TreeNode {

	/**
	 * Add child nodes.
	 * 
	 * @param args
	 *            The child nodes to add.
	 */
	public void addChildNodes(TreeNode[] args);

	/**
	 * @return True, if all children are leaves.
	 */
	public boolean allLeafChildren();

	/**
	 * @return The child nodes.
	 */
	public List<TreeNode> getChildNodes();

	/**
	 * @return True, if this is a leaf.
	 */
	public boolean isLeaf();

	/**
	 * @return The number of nodes from this point. Do not call on cyclic tree.
	 */
	public int size();

}