Package org.neo4j.graphalgo.core.utils.mem

Class MemoryEstimations

java.lang.Object

org.neo4j.graphalgo.core.utils.mem.MemoryEstimations

public final class MemoryEstimations
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MemoryEstimations.Builder
static interface	MemoryEstimations.MemoryEstimationSetup
static interface	MemoryEstimations.MemoryRangeModifier

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	RESIDENT_MEMORY
static java.lang.String	TEMPORARY_MEMORY

Method Summary

Modifier and Type	Method	Description
static MemoryEstimation	andThen(java.lang.String description, MemoryEstimation delegate, MemoryEstimations.MemoryRangeModifier andThen)	Updates a given MemoryEstimation by applying a MemoryEstimations.MemoryRangeModifier.
static MemoryEstimation	andThen(MemoryEstimation delegate, java.util.function.UnaryOperator<MemoryRange> andThen)	Updates the memory range of given MemoryEstimation by applying a given function.
static MemoryEstimation	andThen(MemoryEstimation delegate, MemoryEstimations.MemoryRangeModifier andThen)	Updates a given MemoryEstimation by applying a MemoryEstimations.MemoryRangeModifier.
static MemoryEstimations.Builder	builder()	Creates a new MemoryEstimations.Builder with an empty description.
static MemoryEstimations.Builder	builder(java.lang.Class<?> type)	Creates a new MemoryEstimations.Builder from the given class type.
static MemoryEstimations.Builder	builder(java.lang.String description)	Creates a new MemoryEstimations.Builder using the given description.
static MemoryEstimations.Builder	builder(java.lang.String description, java.lang.Class<?> type)	Creates a new MemoryEstimations.Builder using the given description and class type.
static MemoryEstimation	empty()
static MemoryEstimation	of(java.lang.Class<?> instanceType)	Creates a MemoryEstimation for the fields of the given class.
static MemoryEstimation	of(java.lang.String description, MemoryRange range)
static MemoryEstimation	of(java.lang.String description, MemoryResident resident)	Creates a MemoryEstimation using the given MemoryResident function.
static MemoryEstimation	setup(java.lang.String description, java.util.function.Function<GraphDimensions,MemoryEstimation> fn)	Creates a MemoryEstimation using the given function.
static MemoryEstimation	setup(java.lang.String description, MemoryEstimations.MemoryEstimationSetup setup)	Creates a MemoryEstimation using the given MemoryEstimations.MemoryEstimationSetup function.

Methods inherited from class java.lang.Object

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

Field Detail

RESIDENT_MEMORY

public static final java.lang.String RESIDENT_MEMORY

See Also:

Constant Field Values

TEMPORARY_MEMORY

public static final java.lang.String TEMPORARY_MEMORY

See Also:

Constant Field Values

Method Detail

empty

public static MemoryEstimation empty()

of

public static MemoryEstimation of(java.lang.Class<?> instanceType)

Creates a MemoryEstimation for the fields of the given class.

Parameters:

instanceType - class

Returns:

memory estimation

of

public static MemoryEstimation of(java.lang.String description,
                                  MemoryResident resident)

Creates a MemoryEstimation using the given MemoryResident function. Inputs to that function are the GraphDimensions and the number of available threads.

Parameters:

description - description of the sub-component

resident - function to compute a MemoryRange

Returns:

memory estimation

of

public static MemoryEstimation of(java.lang.String description,
                                  MemoryRange range)

setup

public static MemoryEstimation setup(java.lang.String description,
                                     MemoryEstimations.MemoryEstimationSetup setup)

Creates a MemoryEstimation using the given MemoryEstimations.MemoryEstimationSetup function. Inputs to that function are the GraphDimensions and the number of available threads.

Parameters:

description - description of the sub-component

setup - function to compute a MemoryEstimation

Returns:

memory estimation

setup

public static MemoryEstimation setup(java.lang.String description,
                                     java.util.function.Function<GraphDimensions,MemoryEstimation> fn)

Creates a MemoryEstimation using the given function. Inputs to that function are the GraphDimensions.

Parameters:

description - description of the sub-component

fn - function to compute a MemoryEstimation

Returns:

memory estimation

andThen

public static MemoryEstimation andThen(MemoryEstimation delegate,
                                       MemoryEstimations.MemoryRangeModifier andThen)

Updates a given MemoryEstimation by applying a MemoryEstimations.MemoryRangeModifier. The description is inherited from delegate.description().

Parameters:

delegate - memory estimation to modify

andThen - function to update the memory estimation

Returns:

updated memory estimation

andThen

public static MemoryEstimation andThen(MemoryEstimation delegate,
                                       java.util.function.UnaryOperator<MemoryRange> andThen)

Updates the memory range of given MemoryEstimation by applying a given function. The description is inherited from delegate.description().

Parameters:

delegate - memory estimation to modify

andThen - function to update the memory range of the delegate

Returns:

updated memory estimation

andThen

public static MemoryEstimation andThen(java.lang.String description,
                                       MemoryEstimation delegate,
                                       MemoryEstimations.MemoryRangeModifier andThen)

Updates a given MemoryEstimation by applying a MemoryEstimations.MemoryRangeModifier.

Parameters:

description - new description of the memory estimation

delegate - memory estimation to modify

andThen - function to update the memory estimation

Returns:

updated memory estimation

builder

public static MemoryEstimations.Builder builder()

Creates a new MemoryEstimations.Builder with an empty description.

Returns:

builder

builder

public static MemoryEstimations.Builder builder(java.lang.String description)

Creates a new MemoryEstimations.Builder using the given description.

Returns:

builder

builder

public static MemoryEstimations.Builder builder(java.lang.Class<?> type)

Creates a new MemoryEstimations.Builder from the given class type. The description is inferred from the class type by type.getSimpleName().

Returns:

builder

builder

public static MemoryEstimations.Builder builder(java.lang.String description,
                                                java.lang.Class<?> type)

Creates a new MemoryEstimations.Builder using the given description and class type.

Parameters:

description - description of the component

type - class type

Returns:

builder