VariableFEDInstruction (Apache SystemDS 3.3.0 API)

java.lang.Object
- org.apache.sysds.runtime.instructions.Instruction
- - org.apache.sysds.runtime.instructions.fed.FEDInstruction
  - - org.apache.sysds.runtime.instructions.fed.VariableFEDInstruction

All Implemented Interfaces:: LineageTraceable

public class VariableFEDInstruction
extends FEDInstruction
implements LineageTraceable

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.sysds.runtime.instructions.fed.FEDInstruction
  FEDInstruction.FederatedOutput, FEDInstruction.FEDType
- Nested classes/interfaces inherited from class org.apache.sysds.runtime.instructions.Instruction
  Instruction.IType

Field Summary
- Fields inherited from class org.apache.sysds.runtime.instructions.Instruction
  DATATYPE_PREFIX, FEDERATED_INST_PREFIX, GPU_INST_PREFIX, INSTRUCTION_DELIM, LITERAL_PREFIX, OPERAND_DELIM, SP_INST_PREFIX, VALUETYPE_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.apache.commons.lang3.tuple.Pair<String,LineageItem>`	`getLineageItem(ExecutionContext ec)`	Obtain lineage trace of an instruction with a single output.
`static VariableFEDInstruction`	`parseInstruction(VariableCPInstruction inst, ExecutionContext ec)`
`void`	`processInstruction(ExecutionContext ec)`	This method should be used to execute the instruction.

Methods inherited from class org.apache.sysds.runtime.instructions.fed.FEDInstruction
getFEDInstructionType, getTID, getType, setTID

Methods inherited from class org.apache.sysds.runtime.instructions.Instruction
getBeginColumn, getBeginLine, getEndColumn, getEndLine, getExtendedOpcode, getFilename, getGraphString, getInstID, getInstructionString, getLineNum, getOpcode, getOperator, postprocessInstruction, preprocessInstruction, printMe, requiresLabelUpdate, setInstID, setLocation, setLocation, setLocation, setLocation, toString, updateInstructionThreadID

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sysds.runtime.lineage.LineageTraceable
getLineageItems, hasSingleLineage

- Method Detail
  - parseInstruction
```
public static VariableFEDInstruction parseInstruction(VariableCPInstruction inst,
                                                      ExecutionContext ec)
```
  - processInstruction
```
public void processInstruction(ExecutionContext ec)
```
    Description copied from class: Instruction
    
    This method should be used to execute the instruction.
    
    Specified by:
    
    processInstruction in class Instruction
    
    Parameters:
    
    ec - execution context
  - getLineageItem
```
public org.apache.commons.lang3.tuple.Pair<String,LineageItem> getLineageItem(ExecutionContext ec)
```
    Description copied from interface: LineageTraceable
    
    Obtain lineage trace of an instruction with a single output.
    
    Specified by:
    
    getLineageItem in interface LineageTraceable
    
    Parameters:
    
    ec - execution context w/ live variables
    
    Returns:
    
    pair of (output variable name, output lineage item)