Interface WeightsDouble<K>

Type Parameters:
K - the elements (vertices/edges) type
All Superinterfaces:
Comparator<K>, WeightFunction<K>, Weights<K,Double>
All Known Subinterfaces:
IWeightsDouble

public interface WeightsDouble<K> extends Weights<K,Double>, WeightFunction<K>
Specific weights of double.
Author:
Barak Ugav
  • Method Details

    • get

      double get(K element)
      Get the weight associated with the given element.
      Parameters:
      element - an element (edge/vertex).
      Returns:
      the weight associated with the given element.
    • getAsObj

      @Deprecated default Double getAsObj(K element)
      Deprecated.
      Please use get(Object) instead to avoid un/boxing.
      Get the weight associated with the given element.

      This method return the weight as an object, and should not be used when its known what type the weights are.

      Specified by:
      getAsObj in interface Weights<K,Double>
      Parameters:
      element - an element (edge/vertex)
      Returns:
      the weight associated with the given element
    • set

      void set(K element, double weight)
      Set the weight associated with the given element.
      Parameters:
      element - an element (edge/vertex).
      weight - new weight that will be associated with the given element
    • setAsObj

      @Deprecated default void setAsObj(K element, Double weight)
      Deprecated.
      Please use set(Object, double) instead to avoid un/boxing.
      Set the weight associated with the given element.

      This method accept the weight as an object, and should not be used when its known what type the weights are.

      Specified by:
      setAsObj in interface Weights<K,Double>
      Parameters:
      element - an element (edge/vertex)
      weight - new weight that will be associated with the given element
    • defaultWeight

      double defaultWeight()
      Get the default weight of this weights container.

      The default weight is the weight associated with all elements that were not explicitly set using set(Object, double).

      Returns:
      the default weight of this weights container.
    • defaultWeightAsObj

      @Deprecated default Double defaultWeightAsObj()
      Deprecated.
      Please use defaultWeight() instead to avoid un/boxing.
      Get the default weight of this weights container.

      The default weight is the weight associated with all ids that were not explicitly set. This method return the default weight as an object, and should not be used when its known what type the weights are.

      Specified by:
      defaultWeightAsObj in interface Weights<K,Double>
      Returns:
      the default weight of this weights container
    • weight

      default double weight(K element)
      Get the weight of an element.

      Implement the WeightFunction interface by using the weights of the container.

      Specified by:
      weight in interface WeightFunction<K>
      Parameters:
      element - an element identifier
      Returns:
      the weight of the element