com.jgraph.algebra.cost

Interface JGraphCostFunction

public interface JGraphCostFunction

The cost function takes a cell and returns it's cost as a double. Two typical examples of cost functions are the euclidian length of edges or a constant number for each edge. To use one of the built-in cost functions, use either new JGraphDistanceCostFunction(graph.getGraphLayoutCache()) or new JGraphConstantCostFunction(1).
Method Summary
doublegetCost(Object cell)
Evaluates the cost of cell.

Method Detail

getCost

public double getCost(Object cell)
Evaluates the cost of cell.

Parameters: cell the cell to be evaluated

Returns: Returns the cost to traverse cell

Copyright (C) 2001-2009 JGraph Ltd. All rights reserved.