Class Instruction
- java.lang.Object
- 
- org.apache.sysds.runtime.instructions.Instruction
 
- 
- Direct Known Subclasses:
- CPInstruction,- FEDInstruction,- GPUInstruction,- SPInstruction
 
 public abstract class Instruction extends Object 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classInstruction.IType
 - 
Field SummaryFields Modifier and Type Field Description static StringDATATYPE_PREFIXstatic StringFEDERATED_INST_PREFIXstatic StringGPU_INST_PREFIXstatic StringINSTRUCTION_DELIMstatic StringLITERAL_PREFIXstatic StringOPERAND_DELIMstatic StringSP_INST_PREFIXstatic StringVALUETYPE_PREFIX
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description intgetBeginColumn()intgetBeginLine()intgetEndColumn()intgetEndLine()StringgetExtendedOpcode()StringgetFilename()StringgetGraphString()longgetInstID()Getter for instruction unique identifierStringgetInstructionString()intgetLineNum()Getter for instruction line numberStringgetOpcode()OperatorgetOperator()PrivacyConstraintgetPrivacyConstraint()abstract Instruction.ITypegetType()voidpostprocessInstruction(ExecutionContext ec)This method should be used for any tear down after executing this instruction.InstructionpreprocessInstruction(ExecutionContext ec)This method should be used for any setup before executing this instruction.voidprintMe()abstract voidprocessInstruction(ExecutionContext ec)This method should be used to execute the instruction.booleanrequiresLabelUpdate()voidsetInstID(long id)Setter for instruction unique identifiervoidsetLocation(String filename, int beginLine, int endLine, int beginCol, int endCol)voidsetLocation(Lop lop)voidsetLocation(DataIdentifier id)voidsetLocation(Instruction oldInst)voidsetPrivacyConstraint(Lop lop)voidsetPrivacyConstraint(PrivacyConstraint pc)StringtoString()voidupdateInstructionThreadID(String pattern, String replace)All instructions that have thread-specific filenames or names encoded in it should overwrite this method in order to update (1) the in-memory instruction and (2) the instruction string
 
- 
- 
- 
Field Detail- 
OPERAND_DELIMpublic static final String OPERAND_DELIM - See Also:
- Constant Field Values
 
 - 
DATATYPE_PREFIXpublic static final String DATATYPE_PREFIX - See Also:
- Constant Field Values
 
 - 
VALUETYPE_PREFIXpublic static final String VALUETYPE_PREFIX - See Also:
- Constant Field Values
 
 - 
LITERAL_PREFIXpublic static final String LITERAL_PREFIX - See Also:
- Constant Field Values
 
 - 
INSTRUCTION_DELIMpublic static final String INSTRUCTION_DELIM - See Also:
- Constant Field Values
 
 - 
SP_INST_PREFIXpublic static final String SP_INST_PREFIX - See Also:
- Constant Field Values
 
 - 
GPU_INST_PREFIXpublic static final String GPU_INST_PREFIX - See Also:
- Constant Field Values
 
 - 
FEDERATED_INST_PREFIXpublic static final String FEDERATED_INST_PREFIX - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getFilenamepublic String getFilename() 
 - 
getBeginLinepublic int getBeginLine() 
 - 
getEndLinepublic int getEndLine() 
 - 
getBeginColumnpublic int getBeginColumn() 
 - 
getEndColumnpublic int getEndColumn() 
 - 
getTypepublic abstract Instruction.IType getType() 
 - 
setLocationpublic void setLocation(String filename, int beginLine, int endLine, int beginCol, int endCol) 
 - 
setLocationpublic void setLocation(Lop lop) 
 - 
setLocationpublic void setLocation(DataIdentifier id) 
 - 
setLocationpublic void setLocation(Instruction oldInst) 
 - 
setPrivacyConstraintpublic void setPrivacyConstraint(Lop lop) 
 - 
setPrivacyConstraintpublic void setPrivacyConstraint(PrivacyConstraint pc) 
 - 
getPrivacyConstraintpublic PrivacyConstraint getPrivacyConstraint() 
 - 
getOperatorpublic Operator getOperator() 
 - 
getLineNumpublic int getLineNum() Getter for instruction line number- Returns:
- lineNum Instruction approximate DML script line number
 
 - 
setInstIDpublic void setInstID(long id) Setter for instruction unique identifier- Parameters:
- id- Instruction unique identifier
 
 - 
getInstIDpublic long getInstID() Getter for instruction unique identifier- Returns:
- instID Instruction unique identifier
 
 - 
printMepublic void printMe() 
 - 
getInstructionStringpublic String getInstructionString() 
 - 
getGraphStringpublic String getGraphString() 
 - 
getOpcodepublic String getOpcode() 
 - 
getExtendedOpcodepublic String getExtendedOpcode() 
 - 
requiresLabelUpdatepublic boolean requiresLabelUpdate() 
 - 
updateInstructionThreadIDpublic void updateInstructionThreadID(String pattern, String replace) All instructions that have thread-specific filenames or names encoded in it should overwrite this method in order to update (1) the in-memory instruction and (2) the instruction string- Parameters:
- pattern- ?
- replace- ?
 
 - 
preprocessInstructionpublic Instruction preprocessInstruction(ExecutionContext ec) This method should be used for any setup before executing this instruction. Overwriting methods should first call the super method and subsequently do their custom setup.- Parameters:
- ec- execution context
- Returns:
- instruction
 
 - 
processInstructionpublic abstract void processInstruction(ExecutionContext ec) This method should be used to execute the instruction.- Parameters:
- ec- execution context
 
 - 
postprocessInstructionpublic void postprocessInstruction(ExecutionContext ec) This method should be used for any tear down after executing this instruction. Overwriting methods should first do their custom tear down and subsequently call the super method.- Parameters:
- ec- execution context
 
 
- 
 
-