Interface mxICostFunction

All Known Implementing Classes:
mxConstantCostFunction, mxConstCostFunction, mxCostFunction, mxDistanceCostFunction, mxDoubleValCostFunction, mxGeneratorConstFunction, mxGeneratorFunction, mxGeneratorRandomFunction, mxGeneratorRandomIntFunction
public interface mxICostFunction
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 mxDistanceCostFunction(graph) or new mxConstantCostFunction(1).

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getCost(mxCellState state)
    Evaluates the cost of the given cell state.

  • Method Details

    • getCost

      double getCost(mxCellState state)
      Evaluates the cost of the given cell state.
      Parameters:
      state - The cell state to be evaluated
      Returns:
      Returns the cost to traverse the given cell state.