Module lb_op

Balance operation structure.

Copyright © 2010-2011 Zuse Institute Berlin

Version: $Id$

Authors: Nico Kruber (kruber@zib.de).

Description

Balance operation structure

Data Types

id()

id() = any()

lb_op()

abstract datatype: lb_op()

Function Index

get/2Gets the selected property from the load balancing operation.
is_jump/1Determines whether the operation is a jump.
is_no_op/1Determines whether the operation is a no_op, i.e.
is_slide/1Determines whether the operation is a slide.
jump_op/7Creates a new jump operation with the given nodes and their details after the jump.
no_op/0Creates a no_op operation.
slide_op/5Creates a new slide operation with the given nodes and their details after the slide.

Function Details

no_op/0

no_op() -> lb_op()

Creates a no_op operation.

slide_op/5

slide_op(Id :: id(),
         Node :: node_details:node_details(),
         Successor :: node_details:node_details(),
         NodeNew :: node_details:node_details(),
         SuccessorNew :: node_details:node_details()) ->
            lb_op()

Creates a new slide operation with the given nodes and their details after the slide.

jump_op/7

jump_op(Id :: id(),
        NodeToMove :: node_details:node_details(),
        NodeToMove_succ :: node_details:node_details(),
        NodePosition :: node_details:node_details(),
        NodeToMoveNew :: node_details:node_details(),
        NodeToMove_succNew :: node_details:node_details(),
        NodePositionNew :: node_details:node_details()) ->
           lb_op()

Creates a new jump operation with the given nodes and their details after the jump.

is_no_op/1

is_no_op(Op :: lb_op()) -> boolean()

Determines whether the operation is a no_op, i.e. no operation.

is_slide/1

is_slide(Op :: lb_op()) -> boolean()

Determines whether the operation is a slide.

is_jump/1

is_jump(Op :: lb_op()) -> boolean()

Determines whether the operation is a jump.

get/2

get(Lb_op :: lb_op(), Key :: n1 | n1succ | n1_new | n1succ_new) ->
       node_details:node_details()

Gets the selected property from the load balancing operation.


Generated by EDoc, Aug 2 2016, 13:42:11.