org.apache.hadoop.yarn.util.resource

Class Resources

java.lang.Object

org.apache.hadoop.yarn.util.resource.Resources

@InterfaceAudience.LimitedPrivate(value={"YARN","MapReduce"})
 @InterfaceStability.Unstable
public class Resources
extends Object

Resources is a computation class which provides a set of apis to do mathematical operations on Resource object.

Constructor Summary

Constructors

Constructor and Description
Resources()

Method Summary

Modifier and Type	Method and Description
static org.apache.hadoop.yarn.api.records.Resource	add(org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	addTo(org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	clone(org.apache.hadoop.yarn.api.records.Resource res)
static org.apache.hadoop.yarn.api.records.Resource	componentwiseMax(org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	componentwiseMin(org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	createResource(int memory)
static org.apache.hadoop.yarn.api.records.Resource	createResource(int memory, int cores)
static org.apache.hadoop.yarn.api.records.Resource	createResource(long memory)
static org.apache.hadoop.yarn.api.records.Resource	createResource(long memory, int cores)
static float	divide(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	divideAndCeil(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource lhs, float rhs)
static org.apache.hadoop.yarn.api.records.Resource	divideAndCeil(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource lhs, int rhs)
static boolean	equals(org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static boolean	fitsIn(ResourceCalculator rc, org.apache.hadoop.yarn.api.records.Resource smaller, org.apache.hadoop.yarn.api.records.Resource bigger)
static boolean	fitsIn(org.apache.hadoop.yarn.api.records.Resource smaller, org.apache.hadoop.yarn.api.records.Resource bigger)
static boolean	greaterThan(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static boolean	greaterThanOrEqual(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static boolean	isInvalidDivisor(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource divisor)
static boolean	isNone(org.apache.hadoop.yarn.api.records.Resource other) Check whether a resource object is empty (0 memory and 0 virtual cores).
static boolean	lessThan(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static boolean	lessThanOrEqual(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	max(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	min(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource clusterResource, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	multiply(org.apache.hadoop.yarn.api.records.Resource lhs, double by)
static org.apache.hadoop.yarn.api.records.Resource	multiplyAndAddTo(org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs, double by) Multiply rhs by by, and add the result to lhs without creating any new Resource object.
static org.apache.hadoop.yarn.api.records.Resource	multiplyAndNormalizeDown(ResourceCalculator calculator, org.apache.hadoop.yarn.api.records.Resource lhs, double by, org.apache.hadoop.yarn.api.records.Resource factor)
static org.apache.hadoop.yarn.api.records.Resource	multiplyAndNormalizeUp(ResourceCalculator calculator, org.apache.hadoop.yarn.api.records.Resource lhs, double[] by, org.apache.hadoop.yarn.api.records.Resource factor)
static org.apache.hadoop.yarn.api.records.Resource	multiplyAndNormalizeUp(ResourceCalculator calculator, org.apache.hadoop.yarn.api.records.Resource lhs, double by, org.apache.hadoop.yarn.api.records.Resource factor)
static org.apache.hadoop.yarn.api.records.Resource	multiplyAndRoundDown(org.apache.hadoop.yarn.api.records.Resource lhs, double by) Multiply lhs by by, and set the result rounded down into a cloned version of lhs Resource object.
static org.apache.hadoop.yarn.api.records.Resource	multiplyAndRoundUp(org.apache.hadoop.yarn.api.records.Resource lhs, double by) Multiply lhs by by, and set the result rounded up into a cloned version of lhs Resource object.
static org.apache.hadoop.yarn.api.records.Resource	multiplyTo(org.apache.hadoop.yarn.api.records.Resource lhs, double by)
static org.apache.hadoop.yarn.api.records.Resource	negate(org.apache.hadoop.yarn.api.records.Resource resource)
static org.apache.hadoop.yarn.api.records.Resource	none()
static org.apache.hadoop.yarn.api.records.Resource	normalize(ResourceCalculator calculator, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource min, org.apache.hadoop.yarn.api.records.Resource max, org.apache.hadoop.yarn.api.records.Resource increment)
static org.apache.hadoop.yarn.api.records.Resource	normalizeDown(ResourceCalculator calculator, org.apache.hadoop.yarn.api.records.Resource resource, org.apache.hadoop.yarn.api.records.Resource factor)
static float	ratio(ResourceCalculator resourceCalculator, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	roundDown(ResourceCalculator calculator, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource factor)
static org.apache.hadoop.yarn.api.records.Resource	roundUp(ResourceCalculator calculator, org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource factor)
static org.apache.hadoop.yarn.api.records.Resource	subtract(org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	subtractFrom(org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs)
static org.apache.hadoop.yarn.api.records.Resource	subtractFromNonNegative(org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs) Subtract rhs from lhs and reset any negative values to zero.
static org.apache.hadoop.yarn.api.records.Resource	subtractNonNegative(org.apache.hadoop.yarn.api.records.Resource lhs, org.apache.hadoop.yarn.api.records.Resource rhs) Subtract rhs from lhs and reset any negative values to zero.
static org.apache.hadoop.yarn.api.records.Resource	unbounded()

Methods inherited from class java.lang.Object

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

Constructor Detail

Resources

public Resources()

Method Detail

createResource

public static org.apache.hadoop.yarn.api.records.Resource createResource(int memory)

createResource

public static org.apache.hadoop.yarn.api.records.Resource createResource(int memory,
                                                                         int cores)

createResource

public static org.apache.hadoop.yarn.api.records.Resource createResource(long memory)

createResource

public static org.apache.hadoop.yarn.api.records.Resource createResource(long memory,
                                                                         int cores)

none

public static org.apache.hadoop.yarn.api.records.Resource none()

isNone

public static boolean isNone(org.apache.hadoop.yarn.api.records.Resource other)

Check whether a resource object is empty (0 memory and 0 virtual cores).

Parameters:

other - The resource to check

Returns:

true if other has 0 memory and 0 virtual cores, false otherwise

unbounded

public static org.apache.hadoop.yarn.api.records.Resource unbounded()

clone

public static org.apache.hadoop.yarn.api.records.Resource clone(org.apache.hadoop.yarn.api.records.Resource res)

addTo

public static org.apache.hadoop.yarn.api.records.Resource addTo(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                org.apache.hadoop.yarn.api.records.Resource rhs)

add

public static org.apache.hadoop.yarn.api.records.Resource add(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                              org.apache.hadoop.yarn.api.records.Resource rhs)

subtractFrom

public static org.apache.hadoop.yarn.api.records.Resource subtractFrom(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                       org.apache.hadoop.yarn.api.records.Resource rhs)

subtract

public static org.apache.hadoop.yarn.api.records.Resource subtract(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                   org.apache.hadoop.yarn.api.records.Resource rhs)

subtractFromNonNegative

public static org.apache.hadoop.yarn.api.records.Resource subtractFromNonNegative(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                                  org.apache.hadoop.yarn.api.records.Resource rhs)

Subtract rhs from lhs and reset any negative values to zero. This call will modify lhs.

Parameters:

lhs - Resource to subtract from

rhs - Resource to subtract

Returns:

the value of lhs after subtraction

subtractNonNegative

public static org.apache.hadoop.yarn.api.records.Resource subtractNonNegative(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                              org.apache.hadoop.yarn.api.records.Resource rhs)

Subtract rhs from lhs and reset any negative values to zero. This call will operate on a copy of lhs, leaving lhs unmodified.

Parameters:

lhs - Resource to subtract from

rhs - Resource to subtract

Returns:

the value of lhs after subtraction

negate

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

multiplyTo

public static org.apache.hadoop.yarn.api.records.Resource multiplyTo(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                     double by)

multiply

public static org.apache.hadoop.yarn.api.records.Resource multiply(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                   double by)

multiplyAndAddTo

public static org.apache.hadoop.yarn.api.records.Resource multiplyAndAddTo(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                           org.apache.hadoop.yarn.api.records.Resource rhs,
                                                                           double by)

Multiply rhs by by, and add the result to lhs without creating any new Resource object.

Parameters:

lhs - Resource to subtract from.

rhs - Resource to subtract.

by - multiplier.

Returns:

instance of Resource.

multiplyAndNormalizeUp

public static org.apache.hadoop.yarn.api.records.Resource multiplyAndNormalizeUp(ResourceCalculator calculator,
                                                                                 org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                                 double[] by,
                                                                                 org.apache.hadoop.yarn.api.records.Resource factor)

multiplyAndNormalizeUp

public static org.apache.hadoop.yarn.api.records.Resource multiplyAndNormalizeUp(ResourceCalculator calculator,
                                                                                 org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                                 double by,
                                                                                 org.apache.hadoop.yarn.api.records.Resource factor)

multiplyAndNormalizeDown

public static org.apache.hadoop.yarn.api.records.Resource multiplyAndNormalizeDown(ResourceCalculator calculator,
                                                                                   org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                                   double by,
                                                                                   org.apache.hadoop.yarn.api.records.Resource factor)

multiplyAndRoundDown

public static org.apache.hadoop.yarn.api.records.Resource multiplyAndRoundDown(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                               double by)

Multiply lhs by by, and set the result rounded down into a cloned version of lhs Resource object.

Parameters:

lhs - Resource object

by - Multiply values by this value

Returns:

A cloned version of lhs with updated values

multiplyAndRoundUp

public static org.apache.hadoop.yarn.api.records.Resource multiplyAndRoundUp(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                             double by)

Multiply lhs by by, and set the result rounded up into a cloned version of lhs Resource object.

Parameters:

lhs - Resource object

by - Multiply values by this value

Returns:

A cloned version of lhs with updated values

normalize

public static org.apache.hadoop.yarn.api.records.Resource normalize(ResourceCalculator calculator,
                                                                    org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                    org.apache.hadoop.yarn.api.records.Resource min,
                                                                    org.apache.hadoop.yarn.api.records.Resource max,
                                                                    org.apache.hadoop.yarn.api.records.Resource increment)

roundUp

public static org.apache.hadoop.yarn.api.records.Resource roundUp(ResourceCalculator calculator,
                                                                  org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                  org.apache.hadoop.yarn.api.records.Resource factor)

roundDown

public static org.apache.hadoop.yarn.api.records.Resource roundDown(ResourceCalculator calculator,
                                                                    org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                    org.apache.hadoop.yarn.api.records.Resource factor)

isInvalidDivisor

public static boolean isInvalidDivisor(ResourceCalculator resourceCalculator,
                                       org.apache.hadoop.yarn.api.records.Resource divisor)

ratio

public static float ratio(ResourceCalculator resourceCalculator,
                          org.apache.hadoop.yarn.api.records.Resource lhs,
                          org.apache.hadoop.yarn.api.records.Resource rhs)

divide

public static float divide(ResourceCalculator resourceCalculator,
                           org.apache.hadoop.yarn.api.records.Resource clusterResource,
                           org.apache.hadoop.yarn.api.records.Resource lhs,
                           org.apache.hadoop.yarn.api.records.Resource rhs)

divideAndCeil

public static org.apache.hadoop.yarn.api.records.Resource divideAndCeil(ResourceCalculator resourceCalculator,
                                                                        org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                        int rhs)

divideAndCeil

public static org.apache.hadoop.yarn.api.records.Resource divideAndCeil(ResourceCalculator resourceCalculator,
                                                                        org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                        float rhs)

equals

public static boolean equals(org.apache.hadoop.yarn.api.records.Resource lhs,
                             org.apache.hadoop.yarn.api.records.Resource rhs)

lessThan

public static boolean lessThan(ResourceCalculator resourceCalculator,
                               org.apache.hadoop.yarn.api.records.Resource clusterResource,
                               org.apache.hadoop.yarn.api.records.Resource lhs,
                               org.apache.hadoop.yarn.api.records.Resource rhs)

lessThanOrEqual

public static boolean lessThanOrEqual(ResourceCalculator resourceCalculator,
                                      org.apache.hadoop.yarn.api.records.Resource clusterResource,
                                      org.apache.hadoop.yarn.api.records.Resource lhs,
                                      org.apache.hadoop.yarn.api.records.Resource rhs)

greaterThan

public static boolean greaterThan(ResourceCalculator resourceCalculator,
                                  org.apache.hadoop.yarn.api.records.Resource clusterResource,
                                  org.apache.hadoop.yarn.api.records.Resource lhs,
                                  org.apache.hadoop.yarn.api.records.Resource rhs)

greaterThanOrEqual

public static boolean greaterThanOrEqual(ResourceCalculator resourceCalculator,
                                         org.apache.hadoop.yarn.api.records.Resource clusterResource,
                                         org.apache.hadoop.yarn.api.records.Resource lhs,
                                         org.apache.hadoop.yarn.api.records.Resource rhs)

min

public static org.apache.hadoop.yarn.api.records.Resource min(ResourceCalculator resourceCalculator,
                                                              org.apache.hadoop.yarn.api.records.Resource clusterResource,
                                                              org.apache.hadoop.yarn.api.records.Resource lhs,
                                                              org.apache.hadoop.yarn.api.records.Resource rhs)

max

public static org.apache.hadoop.yarn.api.records.Resource max(ResourceCalculator resourceCalculator,
                                                              org.apache.hadoop.yarn.api.records.Resource clusterResource,
                                                              org.apache.hadoop.yarn.api.records.Resource lhs,
                                                              org.apache.hadoop.yarn.api.records.Resource rhs)

fitsIn

public static boolean fitsIn(org.apache.hadoop.yarn.api.records.Resource smaller,
                             org.apache.hadoop.yarn.api.records.Resource bigger)

fitsIn

public static boolean fitsIn(ResourceCalculator rc,
                             org.apache.hadoop.yarn.api.records.Resource smaller,
                             org.apache.hadoop.yarn.api.records.Resource bigger)

componentwiseMin

public static org.apache.hadoop.yarn.api.records.Resource componentwiseMin(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                           org.apache.hadoop.yarn.api.records.Resource rhs)

componentwiseMax

public static org.apache.hadoop.yarn.api.records.Resource componentwiseMax(org.apache.hadoop.yarn.api.records.Resource lhs,
                                                                           org.apache.hadoop.yarn.api.records.Resource rhs)

normalizeDown

public static org.apache.hadoop.yarn.api.records.Resource normalizeDown(ResourceCalculator calculator,
                                                                        org.apache.hadoop.yarn.api.records.Resource resource,
                                                                        org.apache.hadoop.yarn.api.records.Resource factor)