Class DefaultPairwiseCostCalculator

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean calculate​(PointOnNet[][] startPoints, PointOnNet[][] endPoints, LODNetworkConstraint constraint, Matrix<java.lang.Integer> pairwiseMatrix)
      Computes the pairwise shortest path and the pairwise costs using the pairwise shortest paths algorithm passed in to the constructor.
      Matrix<double[]> getPairwiseCosts()
      Returns the pairwise costs.
      Matrix<LogicalSubPath> getPairwisePaths()
      Returns the pairwise shortest paths.
      java.lang.String getXMLSchema()
      Returns the XML schema for the input parameter.
      void init​(org.w3c.dom.Element parameter)
      Initializes the XML configurable object with the input parameter.
      void setNetworkAnalyst​(NetworkAnalyst analyst)
      This method allows caller to pass the network analyst object to this cost calculator implementation, so that the algorithm can call the analysis functions provided by the network analyst, or access the network explorer associated with the network analyst.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DefaultPairwiseCostCalculator

        public DefaultPairwiseCostCalculator()
      • DefaultPairwiseCostCalculator

        public DefaultPairwiseCostCalculator​(PairwiseShortestPaths pwsp)
        Constructs a default pairwise cost calculator.
        Parameters:
        pwsp - pairwise shortest path algorithm.
    • Method Detail

      • calculate

        public boolean calculate​(PointOnNet[][] startPoints,
                                 PointOnNet[][] endPoints,
                                 LODNetworkConstraint constraint,
                                 Matrix<java.lang.Integer> pairwiseMatrix)
                          throws LODNetworkException
        Computes the pairwise shortest path and the pairwise costs using the pairwise shortest paths algorithm passed in to the constructor.
        Specified by:
        calculate in interface PairwiseCostCalculator
        Parameters:
        startPoints -
        endPoints -
        constraint -
        pairwiseMatrix - a matrix that specifies for which pairs the costs need to be computed. If the matrix element for pair (i, j) is set to 0, then the cost from i to j does not need to be computed; otherwise it must be computed. If this parameter is set to null, then the costs for all pairs must be computed.
        Returns:
        Throws:
        LODNetworkException
      • setNetworkAnalyst

        public void setNetworkAnalyst​(NetworkAnalyst analyst)
        Description copied from interface: PairwiseCostCalculator
        This method allows caller to pass the network analyst object to this cost calculator implementation, so that the algorithm can call the analysis functions provided by the network analyst, or access the network explorer associated with the network analyst. If network analyst is not needed by the cost calculator, the calculator can choose to do nothing with this method.
        Specified by:
        setNetworkAnalyst in interface PairwiseCostCalculator
      • init

        public void init​(org.w3c.dom.Element parameter)
        Description copied from interface: XMLConfigurable
        Initializes the XML configurable object with the input parameter.
        Specified by:
        init in interface XMLConfigurable
        Parameters:
        parameter - an XML element containing the necessary information to initialize the object.
      • getXMLSchema

        public java.lang.String getXMLSchema()
        Description copied from interface: XMLConfigurable
        Returns the XML schema for the input parameter.
        Specified by:
        getXMLSchema in interface XMLConfigurable
        Returns: