org.nd4j.autodiff.samediff.flow

Class FlowPath

java.lang.Object

org.nd4j.autodiff.samediff.flow.FlowPath

public class FlowPath
extends Object

This class acts as holder for flow control information.

Author:

[email protected]

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,FrameState>	frames
protected Map<String,NodeState>	states

Constructor Summary

Constructors

Constructor and Description
FlowPath()

Method Summary

Modifier and Type	Method and Description
void	activateFrame(String frameName, boolean reallyActivate) This method triggers frame state
void	ensureNodeStateExists(String nodeName) This method checks if NodeState was created for specified graph node
void	forgetFrame(String frame_name) This method removes specified frame from tracking
int	getActiveBranch(String nodeName) This method returns active branch of specific node (if any)
long	getNumberOfCycles(String frameName) This method returns number of iterations of specified node.
int	getRewindPosition(String frameName) This method returns planned position within graph for next rewind.
void	incrementNumberOfCycles(String frameName) This node increments number of iterations by 1.
boolean	isActive(String nodeName) This method checks, if specified graph node is active (as in - located within active code branch, and was NOT left in inactive branch)
boolean	isFrameActive(String frameName) This method returns TRUE if specified frame was activated (as in: Enter/Merge was triggered)
boolean	isRegisteredFrame(String frame_name) This method returns TRUE if frame_name already registered, false otherwise
boolean	isRewindPlanned(String frameName) This method checks, if rewind was planned for specified frame_name
boolean	isRewindPossible(String frameName)
void	markActive(String nodeName, boolean active) This method allows to set specified node active or inactive.
void	markExecuted(String nodeName, boolean executed) This method allows to toggle wasExecuted() state for specified node
void	planRewind(String frameName, boolean reallyPlan) This method announces future rewind of graph execution to specified position
void	registerFrame(String frame_name) This method adds Frame to tracking PLEASE NOTE: Only works for first call, subsequent calls are no-op
void	setActiveBranch(String nodeName, int branchIdx) This method sets active/inactive branch for divergent nodes (aka Switch)
void	setRewindPosition(String frameName, int position) This method allows to set position for next rewind within graph
void	setRewindPositionOnce(String frameName, int position) This method allows to set position for next rewind within graph.
boolean	wasExecuted(String nodeName) This method returns TRUE if specified node was already executed during current pass, FALSE otherwise

Methods inherited from class java.lang.Object

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

Field Detail

states

protected Map<String,NodeState> states

frames

protected Map<String,FrameState> frames

Constructor Detail

FlowPath

public FlowPath()

Method Detail

ensureNodeStateExists

public void ensureNodeStateExists(@NonNull
                                  String nodeName)

This method checks if NodeState was created for specified graph node

Parameters:

nodeName -

isActive

public boolean isActive(@NonNull
                        String nodeName)

This method checks, if specified graph node is active (as in - located within active code branch, and was NOT left in inactive branch)

Parameters:

nodeName -

Returns:

markActive

public void markActive(@NonNull
                       String nodeName,
                       boolean active)

This method allows to set specified node active or inactive. PLEASE NOTE: All nodes using this node as input, will be considered inactive, if this node is set to be inactive.

Parameters:

nodeName -

active -

setActiveBranch

public void setActiveBranch(@NonNull
                            String nodeName,
                            int branchIdx)

This method sets active/inactive branch for divergent nodes (aka Switch)

Parameters:

nodeName -

branchIdx -

getActiveBranch

public int getActiveBranch(@NonNull
                           String nodeName)

This method returns active branch of specific node (if any)

Parameters:

nodeName -

Returns:

wasExecuted

public boolean wasExecuted(@NonNull
                           String nodeName)

This method returns TRUE if specified node was already executed during current pass, FALSE otherwise

Parameters:

nodeName -

Returns:

markExecuted

public void markExecuted(@NonNull
                         String nodeName,
                         boolean executed)

This method allows to toggle wasExecuted() state for specified node

Parameters:

nodeName -

executed -

incrementNumberOfCycles

public void incrementNumberOfCycles(@NonNull
                                    String frameName)

This node increments number of iterations by 1.

Parameters:

nodeName -

getNumberOfCycles

public long getNumberOfCycles(@NonNull
                              String frameName)

This method returns number of iterations of specified node.

Parameters:

nodeName -

Returns:

registerFrame

public void registerFrame(@NonNull
                          String frame_name)

This method adds Frame to tracking PLEASE NOTE: Only works for first call, subsequent calls are no-op

Parameters:

frame_name -

forgetFrame

public void forgetFrame(@NonNull
                        String frame_name)

This method removes specified frame from tracking

Parameters:

frame_name -

isRegisteredFrame

public boolean isRegisteredFrame(@NonNull
                                 String frame_name)

This method returns TRUE if frame_name already registered, false otherwise

Parameters:

frame_name -

Returns:

isRewindPlanned

public boolean isRewindPlanned(@NonNull
                               String frameName)

This method checks, if rewind was planned for specified frame_name

Returns:

isRewindPossible

public boolean isRewindPossible(@NonNull
                                String frameName)

planRewind

public void planRewind(@NonNull
                       String frameName,
                       boolean reallyPlan)

This method announces future rewind of graph execution to specified position

Parameters:

frameName -

getRewindPosition

public int getRewindPosition(@NonNull
                             String frameName)

This method returns planned position within graph for next rewind.

Parameters:

frameName -

Returns:

setRewindPosition

public void setRewindPosition(@NonNull
                              String frameName,
                              int position)

This method allows to set position for next rewind within graph

Parameters:

frameName -

position -

setRewindPositionOnce

public void setRewindPositionOnce(@NonNull
                                  String frameName,
                                  int position)

This method allows to set position for next rewind within graph. PLEASE NOTE: This methods check, if rewind position wasn't set yet. If it was already set for this frame - it'll be no-op method

Parameters:

frameName -

position -

activateFrame

public void activateFrame(@NonNull
                          String frameName,
                          boolean reallyActivate)

This method triggers frame state

Parameters:

frameName -

reallyActivate -

isFrameActive

public boolean isFrameActive(@NonNull
                             String frameName)

This method returns TRUE if specified frame was activated (as in: Enter/Merge was triggered)

Parameters:

frameName -

Returns: