Package com.jgalgo.graph

Interface WeightsFloat<K>

All Superinterfaces:

Comparator<K>, WeightFunction<K>, Weights<K,Float>

All Known Subinterfaces:

IWeightsFloat

public interface WeightsFloat<K>
extends Weights<K,Float>, WeightFunction<K>

Specific weights of float.

Author:

Barak Ugav

Field Summary

Fields inherited from interface com.jgalgo.graph.WeightFunction

CardinalityWeightFunction

Method Summary

Modifier and Type	Method	Description
float	defaultWeight()	Get the default weight of this weights container.
default Float	defaultWeightAsObj()	Deprecated. Please use defaultWeight() instead to avoid un/boxing.
float	get(K element)	Get the weight associated with the given element.
default Float	getAsObj(K element)	Deprecated. Please use get(Object) instead to avoid un/boxing.
void	set(K element, float weight)	Set the weight associated with the given element.
default void	setAsObj(K element, Float weight)	Deprecated. Please use set(Object, float) instead to avoid un/boxing.
default double	weight(K element)	Get the weight of an element.

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface com.jgalgo.graph.WeightFunction

compare, weightSum

Method Detail

get

float 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 Float 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,Float>

Parameters:

element - an element (edge/vertex)

Returns:

the weight associated with the given element

set

void set(K element,
         float 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,
                      Float weight)

Deprecated.

Please use set(Object, float) 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,Float>

Parameters:

element - an element (edge/vertex)

weight - new weight that will be associated with the given element

defaultWeight

float 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, float).

Returns:

the default weight of this weights container.

defaultWeightAsObj

@Deprecated
default Float 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,Float>

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