Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity

Class ResourceVector

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.ResourceVector

All Implemented Interfaces:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Double>>

public class ResourceVector
extends java.lang.Object
implements java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Double>>

Represents a simple resource floating point value grouped by resource names.

Constructor Summary

Constructors

Constructor	Description
ResourceVector()

Method Summary

Modifier and Type	Method	Description
void	decrement(java.lang.String resourceName, double value)	Decrements the given resource by the specified value.
void	decrement(ResourceVector otherResourceVector)	Decrements values for each resource defined in the given resource vector.
boolean	equals(java.lang.Object o)
java.util.Set<java.lang.String>	getResourceNames()
double	getValue(java.lang.String resourceName)
int	hashCode()
void	increment(java.lang.String resourceName, double value)	Increments the given resource by the specified value.
boolean	isEmpty()
java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.Double>>	iterator()
static ResourceVector	newInstance()	Creates a new ResourceVector with all pre-defined resources set to zero.
static ResourceVector	of(double value)	Creates a new ResourceVector with all pre-defined resources set to the same value.
static ResourceVector	of(org.apache.hadoop.yarn.api.records.Resource resource)	Creates a new ResourceVector with the values set in a Resource object.
void	setValue(java.lang.String resourceName, double value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ResourceVector

public ResourceVector()

Method Detail

newInstance

public static ResourceVector newInstance()

Creates a new ResourceVector with all pre-defined resources set to zero.

Returns:

zero resource vector

of

public static ResourceVector of(double value)

Creates a new ResourceVector with all pre-defined resources set to the same value.

Parameters:

value - the value to set all resources to

Returns:

uniform resource vector

of

public static ResourceVector of(org.apache.hadoop.yarn.api.records.Resource resource)

Creates a new ResourceVector with the values set in a Resource object.

Parameters:

resource - resource object the resource vector will be based on

Returns:

uniform resource vector

decrement

public void decrement(ResourceVector otherResourceVector)

Decrements values for each resource defined in the given resource vector.

Parameters:

otherResourceVector - rhs resource vector of the subtraction

decrement

public void decrement(java.lang.String resourceName,
                      double value)

Decrements the given resource by the specified value.

Parameters:

resourceName - name of the resource

value - value to be subtracted from the resource's current value

increment

public void increment(java.lang.String resourceName,
                      double value)

Increments the given resource by the specified value.

Parameters:

resourceName - name of the resource

value - value to be added to the resource's current value

getValue

public double getValue(java.lang.String resourceName)

setValue

public void setValue(java.lang.String resourceName,
                     double value)

isEmpty

public boolean isEmpty()

getResourceNames

public java.util.Set<java.lang.String> getResourceNames()

iterator

public java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.Double>> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Double>>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object