[SYSTEMML-842] Javadoc cleanup in functionobjects and instructions packages
Remove blank comments. Fix broken comments. Project: http://git-wip-us.apache.org/repos/asf/incubator-systemml/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-systemml/commit/dd8adccb Tree: http://git-wip-us.apache.org/repos/asf/incubator-systemml/tree/dd8adccb Diff: http://git-wip-us.apache.org/repos/asf/incubator-systemml/diff/dd8adccb Branch: refs/heads/master Commit: dd8adccb31c8499c20856486a804c2c210844e3c Parents: e77205d Author: Deron Eriksson <de...@us.ibm.com> Authored: Tue Nov 15 16:28:00 2016 -0800 Committer: Deron Eriksson <de...@us.ibm.com> Committed: Tue Nov 15 16:28:00 2016 -0800 ---------------------------------------------------------------------- .../sysml/runtime/functionobjects/Builtin.java | 20 +- .../sysml/runtime/functionobjects/COV.java | 17 +- .../sysml/runtime/functionobjects/CTable.java | 40 +- .../runtime/functionobjects/GreaterThan.java | 2 +- .../functionobjects/GreaterThanEquals.java | 2 +- .../runtime/functionobjects/IntegerDivide.java | 6 +- .../runtime/functionobjects/KahanFunction.java | 8 +- .../runtime/functionobjects/KahanPlus.java | 4 +- .../runtime/functionobjects/KahanPlusSq.java | 2 + .../sysml/runtime/functionobjects/LessThan.java | 2 +- .../runtime/functionobjects/LessThanEquals.java | 2 +- .../sysml/runtime/functionobjects/Mean.java | 5 +- .../functionobjects/ParameterizedBuiltin.java | 12 +- .../sysml/runtime/instructions/Instruction.java | 29 +- .../runtime/instructions/InstructionUtils.java | 180 +--- .../runtime/instructions/MRJobInstruction.java | 65 +- .../cp/AggregateBinaryCPInstruction.java | 6 - .../cp/AggregateTernaryCPInstruction.java | 6 - .../instructions/cp/AppendCPInstruction.java | 8 +- .../instructions/cp/BreakPointInstruction.java | 5 +- .../runtime/instructions/cp/CM_COV_Object.java | 18 +- .../cp/ComputationCPInstruction.java | 17 +- .../cp/CovarianceCPInstruction.java | 6 - .../cp/DataPartitionCPInstruction.java | 12 +- .../cp/FunctionCallCPInstruction.java | 20 +- .../instructions/cp/IndexingCPInstruction.java | 16 +- .../instructions/cp/MMChainCPInstruction.java | 12 +- .../instructions/cp/MMTSJCPInstruction.java | 12 +- .../cp/MatrixReshapeCPInstruction.java | 12 +- ...ReturnParameterizedBuiltinCPInstruction.java | 8 +- .../instructions/cp/PMMJCPInstruction.java | 12 +- .../cp/QuantilePickCPInstruction.java | 8 +- .../cp/QuaternaryCPInstruction.java | 10 - .../instructions/cp/ReorgCPInstruction.java | 26 +- .../instructions/cp/ScalarObjectFactory.java | 7 +- .../cp/StringInitCPInstruction.java | 8 +- .../runtime/instructions/cp/StringObject.java | 4 - .../instructions/cp/VariableCPInstruction.java | 43 +- .../ParameterizedBuiltinCPFileInstruction.java | 130 +-- .../gpu/AggregateBinaryGPUInstruction.java | 24 +- .../gpu/ConvolutionGPUInstruction.java | 10 +- .../instructions/gpu/MMTSJGPUInstruction.java | 18 +- .../instructions/gpu/context/GPUContext.java | 3 +- .../instructions/gpu/context/GPUObject.java | 19 +- .../instructions/gpu/context/JCudaObject.java | 67 +- .../mr/AggregateBinaryInstruction.java | 34 +- .../mr/AggregateUnaryInstruction.java | 8 +- .../instructions/mr/AppendInstruction.java | 18 +- .../mr/BinUaggChainInstruction.java | 22 +- .../instructions/mr/BinaryMInstruction.java | 8 +- .../mr/CumulativeSplitInstruction.java | 4 - .../mr/GroupedAggregateMInstruction.java | 8 +- .../mr/IDistributedCacheConsumer.java | 10 +- .../instructions/mr/MMTSJMRInstruction.java | 19 +- .../runtime/instructions/mr/MRInstruction.java | 21 - .../mr/MapMultChainInstruction.java | 51 +- .../mr/MatrixReshapeMRInstruction.java | 13 +- .../instructions/mr/PMMJMRInstruction.java | 13 +- .../mr/ParameterizedBuiltinMRInstruction.java | 15 +- .../instructions/mr/PlusMultInstruction.java | 8 +- .../instructions/mr/QuaternaryInstruction.java | 28 +- .../mr/RangeBasedReIndexInstruction.java | 15 +- .../mr/RemoveEmptyMRInstruction.java | 8 +- .../instructions/mr/ReplicateInstruction.java | 22 +- .../instructions/mr/ScalarInstruction.java | 15 +- .../instructions/mr/TernaryInstruction.java | 64 +- .../mr/UaggOuterChainInstruction.java | 29 +- .../spark/AggregateTernarySPInstruction.java | 13 +- .../spark/AggregateUnarySPInstruction.java | 27 +- .../spark/AppendGAlignedSPInstruction.java | 5 +- .../spark/AppendGSPInstruction.java | 10 +- .../spark/ArithmeticBinarySPInstruction.java | 8 +- .../spark/BinUaggChainSPInstruction.java | 5 +- .../instructions/spark/BinarySPInstruction.java | 67 +- .../spark/BuiltinBinarySPInstruction.java | 8 +- .../spark/BuiltinUnarySPInstruction.java | 8 +- .../spark/CSVReblockSPInstruction.java | 18 +- .../spark/CentralMomentSPInstruction.java | 19 +- .../spark/CheckpointSPInstruction.java | 8 +- .../spark/CompressionSPInstruction.java | 13 +- .../spark/ComputationSPInstruction.java | 21 +- .../spark/CovarianceSPInstruction.java | 24 +- .../instructions/spark/CpmmSPInstruction.java | 16 +- .../spark/CumulativeAggregateSPInstruction.java | 15 +- .../spark/CumulativeOffsetSPInstruction.java | 20 +- .../spark/FrameAppendMSPInstruction.java | 12 +- .../spark/FrameAppendRSPInstruction.java | 11 +- .../spark/FrameIndexingSPInstruction.java | 44 +- .../spark/MapmmChainSPInstruction.java | 9 - .../instructions/spark/MapmmSPInstruction.java | 58 +- .../spark/MatrixAppendMSPInstruction.java | 18 +- .../spark/MatrixAppendRSPInstruction.java | 5 +- .../spark/MatrixBuiltinSPInstruction.java | 8 +- .../spark/MatrixIndexingSPInstruction.java | 61 +- .../spark/MatrixReshapeSPInstruction.java | 12 +- ...ReturnParameterizedBuiltinSPInstruction.java | 37 +- .../instructions/spark/PMapmmSPInstruction.java | 16 +- .../ParameterizedBuiltinSPInstruction.java | 46 +- .../instructions/spark/PmmSPInstruction.java | 15 +- .../spark/QuantilePickSPInstruction.java | 37 +- .../spark/QuaternarySPInstruction.java | 37 +- .../instructions/spark/RandSPInstruction.java | 54 +- .../spark/ReblockSPInstruction.java | 16 +- .../instructions/spark/ReorgSPInstruction.java | 20 +- .../instructions/spark/RmmSPInstruction.java | 17 - .../instructions/spark/SPInstruction.java | 4 - .../spark/TernarySPInstruction.java | 11 +- .../instructions/spark/Tsmm2SPInstruction.java | 26 +- .../instructions/spark/TsmmSPInstruction.java | 14 +- .../spark/UaggOuterChainSPInstruction.java | 34 +- .../instructions/spark/WriteSPInstruction.java | 27 +- .../instructions/spark/ZipmmSPInstruction.java | 12 +- .../spark/data/BroadcastObject.java | 12 +- .../spark/data/CorrMatrixBlock.java | 20 +- .../spark/data/LazyIterableIterator.java | 6 +- .../spark/data/PartitionedBlock.java | 91 +- .../spark/data/PartitionedBroadcast.java | 26 +- .../instructions/spark/data/RDDObject.java | 20 +- .../instructions/spark/data/RowMatrixBlock.java | 20 +- .../ComputeBinaryBlockNnzFunction.java | 3 - .../functions/ExtractBlockForBinaryReblock.java | 9 +- .../spark/functions/ExtractGroup.java | 20 +- .../functions/FilterDiagBlocksFunction.java | 3 - .../functions/FilterNonEmptyBlocksFunction.java | 3 - .../functions/MatrixScalarUnaryFunction.java | 3 - .../functions/OuterVectorBinaryOpFunction.java | 3 - .../spark/utils/FrameRDDAggregateUtils.java | 15 +- .../spark/utils/FrameRDDConverterUtils.java | 225 +---- .../spark/utils/RDDAggregateUtils.java | 151 +--- .../spark/utils/RDDConverterUtils.java | 188 +--- .../spark/utils/RDDConverterUtilsExt.java | 30 +- .../instructions/spark/utils/RDDSortUtils.java | 111 +-- .../instructions/spark/utils/SparkUtils.java | 172 +--- .../sysml/runtime/matrix/data/MatrixBlock.java | 888 +++++-------------- .../matrix/data/MatrixBlockDataInput.java | 15 +- .../matrix/data/MatrixBlockDataOutput.java | 12 +- 136 files changed, 952 insertions(+), 3436 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/Builtin.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/Builtin.java b/src/main/java/org/apache/sysml/runtime/functionobjects/Builtin.java index a1d305f..aa55622 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/Builtin.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/Builtin.java @@ -108,23 +108,13 @@ public class Builtin extends ValueFunction public BuiltinCode getBuiltinCode() { return bFunc; } - - /** - * - * @param str - * @return - */ + public static Builtin getBuiltinFnObject (String str) { BuiltinCode code = String2BuiltinCode.get(str); return getBuiltinFnObject( code ); } - - /** - * - * @param code - * @return - */ + public static Builtin getBuiltinFnObject(BuiltinCode code) { if ( code == null ) @@ -444,9 +434,9 @@ public class Builtin extends ValueFunction /** * Simplified version without exception handling * - * @param in1 - * @param in2 - * @return + * @param in1 double 1 + * @param in2 double 2 + * @return result */ public double execute2(double in1, double in2) { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/COV.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/COV.java b/src/main/java/org/apache/sysml/runtime/functionobjects/COV.java index 79fe208..5e8dac1 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/COV.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/COV.java @@ -61,12 +61,12 @@ public class COV extends ValueFunction /** * General case for arbitrary weights w2 * - * @param in1 - * @param u - * @param v - * @param w2 - * @return - * @throws DMLRuntimeException + * @param in1 input data + * @param u ? + * @param v ? + * @param w2 ? + * @return result + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public Data execute(Data in1, double u, double v, double w2) throws DMLRuntimeException @@ -94,6 +94,11 @@ public class COV extends ValueFunction /** * Special case for weights w2==1 + * + * @param in1 ? + * @param u ? + * @param v ? + * @return result */ public Data execute(Data in1, double u, double v) throws DMLRuntimeException http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/CTable.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/CTable.java b/src/main/java/org/apache/sysml/runtime/functionobjects/CTable.java index ce55c56..f46bff2 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/CTable.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/CTable.java @@ -26,10 +26,6 @@ import org.apache.sysml.runtime.matrix.data.MatrixIndexes; import org.apache.sysml.runtime.matrix.data.Pair; import org.apache.sysml.runtime.util.UtilFunctions; -/** - * - * - */ public class CTable extends ValueFunction { @@ -51,15 +47,7 @@ public class CTable extends ValueFunction // cloning is not supported for singleton classes throw new CloneNotSupportedException(); } - - /** - * - * @param v1 - * @param v2 - * @param w - * @param ctableResult - * @throws DMLRuntimeException - */ + public void execute(double v1, double v2, double w, boolean ignoreZeros, CTableMap resultMap) throws DMLRuntimeException { @@ -87,14 +75,6 @@ public class CTable extends ValueFunction resultMap.aggregate(row, col, w); } - /** - * - * @param v1 - * @param v2 - * @param w - * @param ctableResult - * @throws DMLRuntimeException - */ public void execute(double v1, double v2, double w, boolean ignoreZeros, MatrixBlock ctableResult) throws DMLRuntimeException { @@ -127,15 +107,7 @@ public class CTable extends ValueFunction ctableResult.quickSetValue((int)row-1, (int)col-1, ctableResult.quickGetValue((int)row-1, (int)col-1) + w); } - - /** - * - * @param row - * @param v2 - * @param w - * @param maxCol - * @return - */ + public int execute(int row, double v2, double w, int maxCol, MatrixBlock ctableResult) throws DMLRuntimeException { @@ -159,14 +131,6 @@ public class CTable extends ValueFunction return Math.max(maxCol, (int)col); } - /** - * - * @param row - * @param v2 - * @param w - * @return - * @throws DMLRuntimeException - */ public Pair<MatrixIndexes,Double> execute( long row, double v2, double w ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/GreaterThan.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/GreaterThan.java b/src/main/java/org/apache/sysml/runtime/functionobjects/GreaterThan.java index 19ae9ac..7401cd7 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/GreaterThan.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/GreaterThan.java @@ -53,7 +53,7 @@ public class GreaterThan extends ValueFunction /** * execute() method that returns double is required since current map-reduce * runtime can only produce matrices of doubles. This method is used on MR - * side to perform comparisons on matrices like A>B and A>2.5 + * side to perform comparisons on matrices like A>B and A>2.5 */ @Override public double execute(double in1, double in2) { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/GreaterThanEquals.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/GreaterThanEquals.java b/src/main/java/org/apache/sysml/runtime/functionobjects/GreaterThanEquals.java index 4696a6f..cca6b46 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/GreaterThanEquals.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/GreaterThanEquals.java @@ -53,7 +53,7 @@ public class GreaterThanEquals extends ValueFunction /** * execute() method that returns double is required since current map-reduce * runtime can only produce matrices of doubles. This method is used on MR - * side to perform comparisons on matrices like A>=B and A>=2.5 + * side to perform comparisons on matrices like A>=B and A>=2.5 */ @Override public double execute(double in1, double in2) { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/IntegerDivide.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/IntegerDivide.java b/src/main/java/org/apache/sysml/runtime/functionobjects/IntegerDivide.java index e3806f4..732949b 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/IntegerDivide.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/IntegerDivide.java @@ -69,9 +69,9 @@ public class IntegerDivide extends ValueFunction * or +-INFINITY devision result, the overall output is NOT cast to * int in order to prevent the special double values. * - * @param in1 - * @param in2 - * @return + * @param in1 double input 1 + * @param in2 double input 2 + * @return result */ private double executeIntDiv( double in1, double in2 ) { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/KahanFunction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/KahanFunction.java b/src/main/java/org/apache/sysml/runtime/functionobjects/KahanFunction.java index a85d0c0..8c8f804 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/KahanFunction.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/KahanFunction.java @@ -42,12 +42,6 @@ public abstract class KahanFunction extends ValueFunction implements Serializabl * @param in The current term to be added. */ public abstract void execute2(KahanObject kObj, double in); - - /** - * - * @param kObj - * @param in - * @param count - */ + public abstract void execute3(KahanObject kObj, double in, int count); } http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/KahanPlus.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/KahanPlus.java b/src/main/java/org/apache/sysml/runtime/functionobjects/KahanPlus.java index 77e2617..8cf57e7 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/KahanPlus.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/KahanPlus.java @@ -92,8 +92,8 @@ public class KahanPlus extends KahanFunction implements Serializable * Simplified version of execute(Data in1, double in2) * without exception handling and casts. * - * @param in1 - * @param in2 + * @param in1 kahan object input + * @param in2 double input */ public void execute2(KahanObject in1, double in2) { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/KahanPlusSq.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/KahanPlusSq.java b/src/main/java/org/apache/sysml/runtime/functionobjects/KahanPlusSq.java index 164a43b..d7c188f 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/KahanPlusSq.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/KahanPlusSq.java @@ -43,6 +43,8 @@ public class KahanPlusSq extends KahanFunction implements Serializable { /** * Get the KahanPlusSq singleton object. + * + * @return KahanPlusSq singleton object */ public static KahanPlusSq getKahanPlusSqFnObject() { if (singleObj == null) http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/LessThan.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/LessThan.java b/src/main/java/org/apache/sysml/runtime/functionobjects/LessThan.java index 6775f2c..5cce17e 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/LessThan.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/LessThan.java @@ -53,7 +53,7 @@ public class LessThan extends ValueFunction /** * execute() method that returns double is required since current map-reduce * runtime can only produce matrices of doubles. This method is used on MR - * side to perform comparisons on matrices like A<B and A<2.5 + * side to perform comparisons on matrices like A<B and A<2.5 */ @Override public double execute(double in1, double in2) { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/LessThanEquals.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/LessThanEquals.java b/src/main/java/org/apache/sysml/runtime/functionobjects/LessThanEquals.java index 887fb2d..59cc051 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/LessThanEquals.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/LessThanEquals.java @@ -53,7 +53,7 @@ public class LessThanEquals extends ValueFunction /** * execute() method that returns double is required since current map-reduce * runtime can only produce matrices of doubles. This method is used on MR - * side to perform comparisons on matrices like A<=B and A<=2.5 + * side to perform comparisons on matrices like A<=B and A<=2.5 */ @Override public double execute(double in1, double in2) { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/Mean.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/Mean.java b/src/main/java/org/apache/sysml/runtime/functionobjects/Mean.java index d9125ee..27f1aa3 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/Mean.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/Mean.java @@ -60,8 +60,9 @@ public class Mean extends ValueFunction * Simplified version of execute(Data in1, double in2) * without exception handling and casts. * - * @param in1 - * @param in2 + * @param in1 Kahan object input + * @param in2 double input + * @param count the count to divide by */ public void execute2(KahanObject in1, double in2, double count) { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/functionobjects/ParameterizedBuiltin.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/functionobjects/ParameterizedBuiltin.java b/src/main/java/org/apache/sysml/runtime/functionobjects/ParameterizedBuiltin.java index c542328..7f4fc1c 100644 --- a/src/main/java/org/apache/sysml/runtime/functionobjects/ParameterizedBuiltin.java +++ b/src/main/java/org/apache/sysml/runtime/functionobjects/ParameterizedBuiltin.java @@ -211,12 +211,12 @@ public class ParameterizedBuiltin extends ValueFunction /** * Helper function to compute distribution-specific cdf (both lowertail and uppertail) and inverse cdf. * - * @param dcode - * @param params - * @param inverse - * @return - * @throws MathArithmeticException - * @throws DMLRuntimeException + * @param dcode probablility distribution code + * @param params map of parameters + * @param inverse true if inverse + * @return cdf or inverse cdf + * @throws MathArithmeticException if MathArithmeticException occurs + * @throws DMLRuntimeException if DMLRuntimeException occurs */ private double computeFromDistribution (ProbabilityDistributionCode dcode, HashMap<String,String> params, boolean inverse ) throws MathArithmeticException, DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/Instruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/Instruction.java b/src/main/java/org/apache/sysml/runtime/instructions/Instruction.java index 7676317..9c1aea7 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/Instruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/Instruction.java @@ -73,8 +73,12 @@ public abstract class Instruction } /** - * Setter for instruction line number - * @param ln Exact (or approximate) DML script line number + * Setter for instruction line/column number + * + * @param beginLine beginning line position + * @param endLine ending line position + * @param beginCol beginning column position + * @param endCol ending column position */ public void setLocation ( int beginLine, int endLine, int beginCol, int endCol) { this.beginLine = beginLine; @@ -168,11 +172,7 @@ public abstract class Instruction else return getOpcode(); } - - /** - * - * @return - */ + public boolean requiresLabelUpdate() { return instString.contains( Lop.VARIABLE_NAME_PLACEHOLDER ); @@ -183,9 +183,9 @@ public abstract class Instruction * should overwrite this method in order to update (1) the in-memory instruction * and (2) the instruction string * - * @param pattern - * @param replace - * @throws DMLRuntimeException + * @param pattern ? + * @param replace ? + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public void updateInstructionThreadID(String pattern, String replace) throws DMLRuntimeException @@ -198,9 +198,9 @@ public abstract class Instruction * Overwriting methods should first call the super method and subsequently do * their custom setup. * - * @param ec - * @return - * @throws DMLRuntimeException + * @param ec execution context + * @return instruction + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public Instruction preprocessInstruction(ExecutionContext ec) throws DMLRuntimeException @@ -226,7 +226,8 @@ public abstract class Instruction * Overwriting methods should first do their custom tear down and subsequently * call the super method. * - * @param ec + * @param ec execution context + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public void postprocessInstruction(ExecutionContext ec) throws DMLRuntimeException http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/InstructionUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/InstructionUtils.java b/src/main/java/org/apache/sysml/runtime/instructions/InstructionUtils.java index 8c6b6b5..a18d49b 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/InstructionUtils.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/InstructionUtils.java @@ -87,14 +87,7 @@ import org.apache.sysml.runtime.matrix.operators.UnaryOperator; public class InstructionUtils { - - /** - * - * @param str - * @param expected - * @return - * @throws DMLRuntimeException - */ + public static int checkNumFields( String str, int expected ) throws DMLRuntimeException { @@ -107,14 +100,7 @@ public class InstructionUtils return numFields; } - - /** - * - * @param str - * @param expected - * @return - * @throws DMLRuntimeException - */ + public static int checkNumFields( String[] parts, int expected ) throws DMLRuntimeException { @@ -126,15 +112,7 @@ public class InstructionUtils return numFields; } - - /** - * - * @param parts - * @param expected1 - * @param expected2 - * @return - * @throws DMLRuntimeException - */ + public static int checkNumFields( String[] parts, int expected1, int expected2 ) throws DMLRuntimeException { @@ -146,15 +124,7 @@ public class InstructionUtils return numFields; } - - /** - * - * @param str - * @param expected1 - * @param expected2 - * @return - * @throws DMLRuntimeException - */ + public static int checkNumFields( String str, int expected1, int expected2 ) throws DMLRuntimeException { @@ -173,8 +143,8 @@ public class InstructionUtils * opcode and all input/output operands WITHOUT their data/value type. * i.e., ret.length = parts.length-1 (-1 for execution type) * - * @param str - * @return + * @param str instruction string + * @return instruction parts as string array */ public static String[] getInstructionParts( String str ) { @@ -200,8 +170,8 @@ public class InstructionUtils * * This function is invoked mainly for parsing CPInstructions. * - * @param str - * @return + * @param str instruction string + * @return instruction parts as string array */ public static String[] getInstructionPartsWithValueType( String str ) { @@ -214,60 +184,30 @@ public class InstructionUtils return ret; } - - /** - * - * @param str - * @return - */ + public static String getOpCode( String str ) { int ix1 = str.indexOf(Instruction.OPERAND_DELIM); int ix2 = str.indexOf(Instruction.OPERAND_DELIM, ix1+1); return str.substring(ix1+1, ix2); } - - /** - * - * @param str - * @return - */ + public static MRINSTRUCTION_TYPE getMRType( String str ) { return MRInstructionParser.String2MRInstructionType.get( getOpCode(str) ); } - - /** - * - * @param str - * @return - */ + public static SPINSTRUCTION_TYPE getSPType( String str ) { return SPInstructionParser.String2SPInstructionType.get( getOpCode(str) ); } - - /** - * - * @param str - * @return - */ + public static CPINSTRUCTION_TYPE getCPType( String str ) { return CPInstructionParser.String2CPInstructionType.get( getOpCode(str) ); } - - /** - * - * @param str - * @return - */ + public static GPUINSTRUCTION_TYPE getGPUType( String str ) { return GPUInstructionParser.String2GPUInstructionType.get( getOpCode(str) ); } - - /** - * - * @param opcode - * @return - */ + public static boolean isBuiltinFunction( String opcode ) { Builtin.BuiltinCode bfc = Builtin.String2BuiltinCode.get(opcode); return (bfc != null); @@ -284,8 +224,8 @@ public class InstructionUtils * used the distributed cache; this call can also be used for individual * instructions. * - * @param str - * @return + * @param str instruction set + * @return true if at least one instruction uses distributed cache */ public static boolean isDistributedCacheUsed(String str) { @@ -307,12 +247,7 @@ public class InstructionUtils } return false; } - - /** - * - * @param opcode - * @return - */ + public static AggregateUnaryOperator parseBasicAggregateUnaryOperator(String opcode) { AggregateUnaryOperator aggun = null; @@ -442,14 +377,7 @@ public class InstructionUtils return aggun; } - - /** - * - * @param opcode - * @param corrExists - * @param corrLoc - * @return - */ + public static AggregateOperator parseAggregateOperator(String opcode, String corrExists, String corrLoc) { AggregateOperator agg = null; @@ -498,12 +426,7 @@ public class InstructionUtils return agg; } - - /** - * - * @param uop - * @return - */ + public static AggregateUnaryOperator parseCumulativeAggregateUnaryOperator(UnaryOperator uop) { Builtin f = (Builtin)uop.fn; @@ -519,12 +442,7 @@ public class InstructionUtils throw new RuntimeException("Unsupported cumulative aggregate unary operator: "+f.getBuiltinCode()); } - - /** - * - * @param uop - * @return - */ + public static AggregateUnaryOperator parseBasicCumulativeAggregateUnaryOperator(UnaryOperator uop) { Builtin f = (Builtin)uop.fn; @@ -540,12 +458,7 @@ public class InstructionUtils throw new RuntimeException("Unsupported cumulative aggregate unary operator: "+f.getBuiltinCode()); } - - /** - * - * @param opcode - * @return - */ + public static AggregateUnaryOperator parseCumulativeAggregateUnaryOperator(String opcode) { AggregateUnaryOperator aggun = null; @@ -568,13 +481,7 @@ public class InstructionUtils return aggun; } - - /** - * - * @param opcode - * @return - * @throws DMLRuntimeException - */ + public static BinaryOperator parseBinaryOperator(String opcode) throws DMLRuntimeException { @@ -629,10 +536,10 @@ public class InstructionUtils /** * scalar-matrix operator * - * @param opcode - * @param arg1IsScalar - * @return - * @throws DMLRuntimeException + * @param opcode the opcode + * @param arg1IsScalar ? + * @return scalar operator + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public static ScalarOperator parseScalarBinaryOperator(String opcode, boolean arg1IsScalar) throws DMLRuntimeException @@ -646,11 +553,11 @@ public class InstructionUtils /** * scalar-matrix operator * - * @param opcode - * @param arg1IsScalar - * @param constant - * @return - * @throws DMLRuntimeException + * @param opcode the opcode + * @param arg1IsScalar ? + * @param constant ? + * @return scalar operator + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public static ScalarOperator parseScalarBinaryOperator(String opcode, boolean arg1IsScalar, double constant) throws DMLRuntimeException @@ -756,13 +663,6 @@ public class InstructionUtils throw new DMLRuntimeException("Unknown binary opcode " + opcode); } - - /** - * - * @param opcode - * @return - * @throws DMLRuntimeException - */ public static BinaryOperator parseExtendedBinaryOperator(String opcode) throws DMLRuntimeException { @@ -809,13 +709,7 @@ public class InstructionUtils throw new DMLRuntimeException("Unknown binary opcode " + opcode); } - - - /** - * - * @param opcode - * @return - */ + public static String deriveAggregateOperatorOpcode(String opcode) { if ( opcode.equalsIgnoreCase("uak+") || opcode.equalsIgnoreCase("uark+") || opcode.equalsIgnoreCase("uack+")) @@ -844,11 +738,6 @@ public class InstructionUtils return null; } - /** - * - * @param opcode - * @return - */ public static CorrectionLocationType deriveAggregateOperatorCorrectionLocation(String opcode) { if ( opcode.equalsIgnoreCase("uak+") || opcode.equalsIgnoreCase("uark+") || @@ -871,11 +760,6 @@ public class InstructionUtils return CorrectionLocationType.NONE; } - /** - * - * @param opcode - * @return - */ public static boolean isDistQuaternaryOpcode(String opcode) { return WeightedSquaredLoss.OPCODE.equalsIgnoreCase(opcode) //mapwsloss http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/MRJobInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/MRJobInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/MRJobInstruction.java index 67cf2f3..5b3c7e9 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/MRJobInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/MRJobInstruction.java @@ -126,13 +126,6 @@ public class MRJobInstruction extends Instruction // Indicates the data type of inputVars private DataType[] inputDataTypes; - - /** - * Constructor - * @param instType - * @param type - */ - public MRJobInstruction(JobType type) { setType(Instruction.INSTRUCTION_TYPE.MAPREDUCE_JOB); @@ -143,9 +136,10 @@ public class MRJobInstruction extends Instruction /** * (deep) Copy constructor, primarily used in parfor. * Additionally, replace all occurrences of <code>srcPattern</code> with <code>targetPattern</code> - * @throws IllegalAccessException - * @throws IllegalArgumentException * + * @param that MR job instruction + * @throws IllegalArgumentException if IllegalArgumentException occurs + * @throws IllegalAccessException if IllegalAccessException occurs */ public MRJobInstruction(MRJobInstruction that) throws IllegalArgumentException, IllegalAccessException @@ -298,7 +292,8 @@ public class MRJobInstruction extends Instruction /** * Getter for MRJobInstructionslineNumbers - * @return TreeMap containing all instructions indexed by line number + * + * @return list containing all instructions indexed by line number */ public ArrayList<Integer> getMRJobInstructionsLineNumbers() { @@ -308,8 +303,7 @@ public class MRJobInstruction extends Instruction /** * Method to set outputs (output indices) for a MapReduce instruction. * - * @param outputIndices - * @throws DMLRuntimeException + * @param outputIndices output indices */ public void setOutputs(byte[] outputIndices) { _resultIndices = outputIndices; @@ -317,7 +311,7 @@ public class MRJobInstruction extends Instruction /** * Method to set the number of reducers for a MapReducer instruction. - * @param numReducers + * @param numReducers number of reducers */ public void setNumberOfReducers(int numReducers) { iv_numReducers = numReducers; @@ -326,7 +320,7 @@ public class MRJobInstruction extends Instruction /** * Method to set the replication factor for outputs produced from a MapReduce instruction. * - * @param replication + * @param replication replication factor */ public void setReplication(int replication) { iv_replication = replication; @@ -335,8 +329,8 @@ public class MRJobInstruction extends Instruction /** * Method to set input and output labels for a MapReduce instruction. * - * @param inputLabels - * @param outputLabels + * @param inputLabels input labels + * @param outputLabels output labels */ public void setInputOutputLabels(String[] inputLabels, String[] outputLabels) { this.inputVars = inputLabels; @@ -369,6 +363,7 @@ public class MRJobInstruction extends Instruction /** * Setter for MRJobInstructionslineNumbers field + * * @param MRJobLineNumbers Line numbers for each instruction in this MRJob */ public void setMRJobInstructionsLineNumbers(ArrayList<Integer> MRJobLineNumbers) { @@ -544,7 +539,8 @@ public class MRJobInstruction extends Instruction /** * Search whether or not this MR job contains at least one - * MR instruction with specified line number parameter + * MR instruction with specified line number parameter + * * @param lineNum Line number in DML script * @return Return true if found, otherwise return false */ @@ -676,8 +672,9 @@ public class MRJobInstruction extends Instruction /** * Method for displaying MR instructions interspersed with source code * ONLY USED IN DEBUG MODE + * * @param debug Flag for displaying instructions in debugger test integration - * @return + * @return MR string */ public String getMRString(boolean debug) { @@ -1016,7 +1013,8 @@ public class MRJobInstruction extends Instruction * corresponding matrix objects in <code>inputMatrices</code>. Also, stores * the data types in <code>inputDataTypes</code>. * - * @param pb + * @param ec execution context + * @return array of matrix objects */ public MatrixObject[] extractInputMatrices(ExecutionContext ec) { ArrayList<MatrixObject> inputmat = new ArrayList<MatrixObject>(); @@ -1053,7 +1051,9 @@ public class MRJobInstruction extends Instruction * of MATRIX data type, and stores them in <code>outputMatrices</code>. Also, * populates auxiliary data structures. * - * @param pb + * @param ec execution context + * @return array of matrix objects + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public MatrixObject[] extractOutputMatrices(ExecutionContext ec) throws DMLRuntimeException { outputMatrices = new MatrixObject[getOutputVars().length]; @@ -1255,11 +1255,6 @@ public class MRJobInstruction extends Instruction } } - /** - * - * @param that - * @return - */ public boolean isMergableMRJobInstruction( MRJobInstruction that ) { boolean ret = true; @@ -1298,11 +1293,7 @@ public class MRJobInstruction extends Instruction return ret; } - - /** - * - * @param that - */ + public void mergeMRJobInstruction( MRJobInstruction that ) { if( LOG.isDebugEnabled() ){ @@ -1432,11 +1423,11 @@ public class MRJobInstruction extends Instruction /** * Safe replacement of mr indexes based on transition map. Multiple string replacements - * would fail for crossing transitions: e.g., 1->2, 2->1. + * would fail for crossing transitions: e.g., 1->2, 2->1. * - * @param inst - * @param transMap - * @return + * @param inst instruction string + * @param transMap transition map + * @return result string */ private String replaceInstructionStringWithTransMap( String inst, HashMap<Byte,Byte> transMap ) { @@ -1475,12 +1466,6 @@ public class MRJobInstruction extends Instruction return instOut.toString(); } - /** - * - * @param inst1 - * @param inst2 - * @return - */ private String concatenateInstructions(String inst1, String inst2) { boolean emptyInst1 = (inst1 == null || inst1.length()==0); http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/AggregateBinaryCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/AggregateBinaryCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/AggregateBinaryCPInstruction.java index 374a21b..702e4f3 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/AggregateBinaryCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/AggregateBinaryCPInstruction.java @@ -40,12 +40,6 @@ public class AggregateBinaryCPInstruction extends BinaryCPInstruction _cptype = CPINSTRUCTION_TYPE.AggregateBinary; } - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ public static AggregateBinaryCPInstruction parseInstruction( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/AggregateTernaryCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/AggregateTernaryCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/AggregateTernaryCPInstruction.java index bb704d4..b88c062 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/AggregateTernaryCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/AggregateTernaryCPInstruction.java @@ -38,12 +38,6 @@ public class AggregateTernaryCPInstruction extends ComputationCPInstruction _cptype = CPINSTRUCTION_TYPE.AggregateTernary; } - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ public static AggregateTernaryCPInstruction parseInstruction( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/AppendCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/AppendCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/AppendCPInstruction.java index 15482fd..8dd842f 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/AppendCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/AppendCPInstruction.java @@ -45,13 +45,7 @@ public abstract class AppendCPInstruction extends BinaryCPInstruction _type = type; } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ + public static AppendCPInstruction parseInstruction ( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/BreakPointInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/BreakPointInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/BreakPointInstruction.java index 39fa698..fd3da68 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/BreakPointInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/BreakPointInstruction.java @@ -49,7 +49,8 @@ public class BreakPointInstruction extends Instruction /** * Parameterized constructor for a breakpoint instruction - * @param tp Breakpoint instruction status + * + * @param status Breakpoint instruction status */ public BreakPointInstruction(BPINSTRUCTION_STATUS status) { type = INSTRUCTION_TYPE.BREAKPOINT; @@ -58,7 +59,7 @@ public class BreakPointInstruction extends Instruction /** * Setter for breakpoint instruction status - * @param st Breakpoint current status + * @param status Breakpoint current status */ public void setBPInstructionStatus(BPINSTRUCTION_STATUS status) { bpStatus = status; http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/CM_COV_Object.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/CM_COV_Object.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/CM_COV_Object.java index 4336392..7acb0b9 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/CM_COV_Object.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/CM_COV_Object.java @@ -129,6 +129,10 @@ public class CM_COV_Object extends Data /** * Return the result of the aggregated operation given the * operator. + * + * @param op operator + * @return result of the aggregated operation for the given operator + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public double getRequiredResult(Operator op) throws DMLRuntimeException { @@ -150,6 +154,10 @@ public class CM_COV_Object extends Data /** * Return the result of the aggregated operation given the * operation type. + * + * @param agg aggregate operation type + * @return result of the aggregated operation given the operation type + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public double getRequiredResult(AggregateOperationTypes agg) throws DMLRuntimeException { switch(agg) @@ -171,12 +179,6 @@ public class CM_COV_Object extends Data } } - /** - * - * @param op - * @return - * @throws DMLRuntimeException - */ public double getRequiredPartialResult(Operator op) throws DMLRuntimeException { @@ -202,10 +204,6 @@ public class CM_COV_Object extends Data return c2._sum; } - /** - * - * @return - */ public double getWeight() { return w; http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/ComputationCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/ComputationCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/ComputationCPInstruction.java index 5824926..92d5ef2 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/ComputationCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/ComputationCPInstruction.java @@ -49,24 +49,11 @@ public abstract class ComputationCPInstruction extends CPInstruction public String getOutputVariableName() { return output.getName(); } - - /** - * - * @param in1 - * @param out - * @return - */ + protected boolean checkGuardedRepresentationChange( MatrixBlock in1, MatrixBlock out ) { return checkGuardedRepresentationChange(in1, null, out); } - - /** - * - * @param in1 - * @param in2 - * @param out - * @return - */ + protected boolean checkGuardedRepresentationChange( MatrixBlock in1, MatrixBlock in2, MatrixBlock out ) { double memDense = OptimizerUtils.estimateSize(out.getNumRows(), out.getNumColumns()); http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/CovarianceCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/CovarianceCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/CovarianceCPInstruction.java index 7ee6706..cbb06aa 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/CovarianceCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/CovarianceCPInstruction.java @@ -45,12 +45,6 @@ public class CovarianceCPInstruction extends BinaryCPInstruction _cptype = CPINSTRUCTION_TYPE.AggregateBinary; } - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ public static CovarianceCPInstruction parseInstruction( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/DataPartitionCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/DataPartitionCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/DataPartitionCPInstruction.java index 58ebcb1..2b75460 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/DataPartitionCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/DataPartitionCPInstruction.java @@ -37,10 +37,6 @@ import org.apache.sysml.runtime.matrix.data.MatrixBlock; import org.apache.sysml.runtime.matrix.data.OutputInfo; import org.apache.sysml.runtime.matrix.operators.Operator; -/** - * - * - */ public class DataPartitionCPInstruction extends UnaryCPInstruction { @@ -52,13 +48,7 @@ public class DataPartitionCPInstruction extends UnaryCPInstruction _cptype = CPINSTRUCTION_TYPE.MMTSJ; _pformat = pformat; } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ + public static DataPartitionCPInstruction parseInstruction ( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/FunctionCallCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/FunctionCallCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/FunctionCallCPInstruction.java index 917a7f2..ccb90b6 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/FunctionCallCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/FunctionCallCPInstruction.java @@ -41,10 +41,6 @@ import org.apache.sysml.runtime.controlprogram.context.ExecutionContextFactory; import org.apache.sysml.runtime.instructions.Instruction; import org.apache.sysml.runtime.instructions.InstructionUtils; - -/** - * - */ public class FunctionCallCPInstruction extends CPInstruction { private String _functionName; @@ -74,10 +70,7 @@ public class FunctionCallCPInstruction extends CPInstruction _boundOutputParamNames = boundOutParamNames; } - - /** - * - */ + public static FunctionCallCPInstruction parseInstruction(String str) throws DMLRuntimeException { @@ -255,11 +248,7 @@ public class FunctionCallCPInstruction extends CPInstruction { return _boundOutputParamNames; } - - /** - * - * @param fname - */ + public void setFunctionName(String fname) { //update instruction string @@ -271,11 +260,6 @@ public class FunctionCallCPInstruction extends CPInstruction instOpcode = fname; } - /** - * - * @param pattern - * @param replace - */ public String updateInstStringFunctionName(String pattern, String replace) { //split current instruction http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/IndexingCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/IndexingCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/IndexingCPInstruction.java index 37b1e91..17ff59c 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/IndexingCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/IndexingCPInstruction.java @@ -46,13 +46,7 @@ public abstract class IndexingCPInstruction extends UnaryCPInstruction colLower = cl; colUpper = cu; } - - /** - * - * @param ec - * @return - * @throws DMLRuntimeException - */ + protected IndexRange getIndexRange(ExecutionContext ec) throws DMLRuntimeException { return new IndexRange( //rl, ru, cl, ru (int)(ec.getScalarInput(rowLower.getName(), rowLower.getValueType(), rowLower.isLiteral()).getLongValue()-1), @@ -60,13 +54,7 @@ public abstract class IndexingCPInstruction extends UnaryCPInstruction (int)(ec.getScalarInput(colLower.getName(), colLower.getValueType(), colLower.isLiteral()).getLongValue()-1), (int)(ec.getScalarInput(colUpper.getName(), colUpper.getValueType(), colUpper.isLiteral()).getLongValue()-1)); } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ + public static IndexingCPInstruction parseInstruction ( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/MMChainCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/MMChainCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/MMChainCPInstruction.java index f6b1a82..3fee0d1 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/MMChainCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/MMChainCPInstruction.java @@ -26,10 +26,6 @@ import org.apache.sysml.runtime.instructions.InstructionUtils; import org.apache.sysml.runtime.matrix.data.MatrixBlock; import org.apache.sysml.runtime.matrix.operators.Operator; -/** - * - * - */ public class MMChainCPInstruction extends UnaryCPInstruction { @@ -43,13 +39,7 @@ public class MMChainCPInstruction extends UnaryCPInstruction _type = type; _numThreads = k; } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ + public static MMChainCPInstruction parseInstruction ( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/MMTSJCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/MMTSJCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/MMTSJCPInstruction.java index c67ab1d..ccc472b 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/MMTSJCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/MMTSJCPInstruction.java @@ -26,10 +26,6 @@ import org.apache.sysml.runtime.instructions.InstructionUtils; import org.apache.sysml.runtime.matrix.data.MatrixBlock; import org.apache.sysml.runtime.matrix.operators.Operator; -/** - * - * - */ public class MMTSJCPInstruction extends UnaryCPInstruction { @@ -43,13 +39,7 @@ public class MMTSJCPInstruction extends UnaryCPInstruction _type = type; _numThreads = k; } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ + public static MMTSJCPInstruction parseInstruction ( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/MatrixReshapeCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/MatrixReshapeCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/MatrixReshapeCPInstruction.java index 608d2f6..95f5af7 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/MatrixReshapeCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/MatrixReshapeCPInstruction.java @@ -27,10 +27,6 @@ import org.apache.sysml.runtime.matrix.data.LibMatrixReorg; import org.apache.sysml.runtime.matrix.data.MatrixBlock; import org.apache.sysml.runtime.matrix.operators.Operator; -/** - * - * - */ public class MatrixReshapeCPInstruction extends UnaryCPInstruction { @@ -47,13 +43,7 @@ public class MatrixReshapeCPInstruction extends UnaryCPInstruction _opCols = in3; _opByRow = in4; } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ + public static MatrixReshapeCPInstruction parseInstruction ( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/MultiReturnParameterizedBuiltinCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/MultiReturnParameterizedBuiltinCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/MultiReturnParameterizedBuiltinCPInstruction.java index 5af403d..574f7ff 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/MultiReturnParameterizedBuiltinCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/MultiReturnParameterizedBuiltinCPInstruction.java @@ -46,13 +46,7 @@ public class MultiReturnParameterizedBuiltinCPInstruction extends ComputationCPI public CPOperand getOutput(int i) { return _outputs.get(i); } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ + public static MultiReturnParameterizedBuiltinCPInstruction parseInstruction ( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/PMMJCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/PMMJCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/PMMJCPInstruction.java index 8111cdb..99f031c 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/PMMJCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/PMMJCPInstruction.java @@ -25,10 +25,6 @@ import org.apache.sysml.runtime.instructions.InstructionUtils; import org.apache.sysml.runtime.matrix.data.MatrixBlock; import org.apache.sysml.runtime.matrix.operators.Operator; -/** - * - * - */ public class PMMJCPInstruction extends ComputationCPInstruction { @@ -39,13 +35,7 @@ public class PMMJCPInstruction extends ComputationCPInstruction super(op, in1, in2, in3, out, opcode, istr); _numThreads = k; } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ + public static PMMJCPInstruction parseInstruction ( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/QuantilePickCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/QuantilePickCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/QuantilePickCPInstruction.java index b1f827d..693de24 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/QuantilePickCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/QuantilePickCPInstruction.java @@ -51,13 +51,7 @@ public class QuantilePickCPInstruction extends BinaryCPInstruction _type = type; _inmem = inmem; } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ + public static QuantilePickCPInstruction parseInstruction ( String str ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/QuaternaryCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/QuaternaryCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/QuaternaryCPInstruction.java index a223b08..a7fa3b5 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/QuaternaryCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/QuaternaryCPInstruction.java @@ -33,10 +33,6 @@ import org.apache.sysml.runtime.matrix.data.MatrixValue; import org.apache.sysml.runtime.matrix.operators.Operator; import org.apache.sysml.runtime.matrix.operators.QuaternaryOperator; -/** - * - * - */ public class QuaternaryCPInstruction extends ComputationCPInstruction { @@ -52,12 +48,6 @@ public class QuaternaryCPInstruction extends ComputationCPInstruction _numThreads = k; } - /** - * - * @param inst - * @return - * @throws DMLRuntimeException - */ public static QuaternaryCPInstruction parseInstruction(String inst) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/ReorgCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/ReorgCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/ReorgCPInstruction.java index 63156a1..872a97f 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/ReorgCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/ReorgCPInstruction.java @@ -43,11 +43,11 @@ public class ReorgCPInstruction extends UnaryCPInstruction /** * for opcodes r' and rdiag * - * @param op - * @param in - * @param out - * @param opcode - * @param istr + * @param op operator + * @param in cp input operand + * @param out cp output operand + * @param opcode the opcode + * @param istr ? */ public ReorgCPInstruction(Operator op, CPOperand in, CPOperand out, String opcode, String istr){ super(op, in, out, opcode, istr); @@ -57,14 +57,14 @@ public class ReorgCPInstruction extends UnaryCPInstruction /** * for opcode rsort * - * @param op - * @param in - * @param col - * @param desc - * @param ixret - * @param out - * @param opcode - * @param istr + * @param op operator + * @param in cp input operand + * @param col ? + * @param desc ? + * @param ixret ? + * @param out cp output operand + * @param opcode the opcode + * @param istr ? */ public ReorgCPInstruction(Operator op, CPOperand in, CPOperand col, CPOperand desc, CPOperand ixret, CPOperand out, String opcode, String istr){ this(op, in, out, opcode, istr); http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/ScalarObjectFactory.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/ScalarObjectFactory.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/ScalarObjectFactory.java index 53b46a2..dfb0726 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/ScalarObjectFactory.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/ScalarObjectFactory.java @@ -23,12 +23,7 @@ import org.apache.sysml.parser.Expression.ValueType; public abstract class ScalarObjectFactory { - /** - * - * @param vt - * @param obj - * @return - */ + public static ScalarObject createScalarObject(ValueType vt, Object obj) { switch( vt ) { case BOOLEAN: return new BooleanObject((Boolean)obj); http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/StringInitCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/StringInitCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/StringInitCPInstruction.java index 4d7c9e2..bac796e 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/StringInitCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/StringInitCPInstruction.java @@ -54,13 +54,7 @@ public class StringInitCPInstruction extends UnaryCPInstruction public long getCols() { return _clen; } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ + public static StringInitCPInstruction parseInstruction(String str) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/StringObject.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/StringObject.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/StringObject.java index 093cf94..e953f89 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/StringObject.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/StringObject.java @@ -74,10 +74,6 @@ public class StringObject extends ScalarObject return _value; } - /** - * - * @param len - */ public static void checkMaxStringLength( long len ) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cp/VariableCPInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cp/VariableCPInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cp/VariableCPInstruction.java index 22b3a09..e7dd21a 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cp/VariableCPInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cp/VariableCPInstruction.java @@ -649,12 +649,12 @@ public class VariableCPInstruction extends CPInstruction /** * Handler for mvvar instructions. - * Example: mvvar <srcvar> <destFile> <format> + * Example: mvvar <srcvar> <destFile> <format> * Move the file pointed by srcvar to destFile. * Currently, applicable only when format=binaryblock. * - * @param ec - * @throws DMLRuntimeException + * @param ec execution context + * @throws DMLRuntimeException if DMLRuntimeException occurs */ @SuppressWarnings("rawtypes") private void processMoveInstruction(ExecutionContext ec) throws DMLRuntimeException { @@ -706,10 +706,10 @@ public class VariableCPInstruction extends CPInstruction /** * Handler for cpvar instructions. - * Example: cpvar <srcvar> <destvar> + * Example: cpvar <srcvar> <destvar> * - * @param ec - * @throws DMLRuntimeException + * @param ec execution context + * @throws DMLRuntimeException if DMLRuntimeException occurs */ private void processCopyInstruction(ExecutionContext ec) throws DMLRuntimeException { // get source variable @@ -737,7 +737,8 @@ public class VariableCPInstruction extends CPInstruction * The default behavior is to write out the specified matrix from the instruction, in * the format given by the corresponding symbol table entry. * - * @throws DMLRuntimeException + * @param ec execution context + * @throws DMLRuntimeException if DMLRuntimeException occurs */ private void processWriteInstruction(ExecutionContext ec) throws DMLRuntimeException @@ -771,9 +772,9 @@ public class VariableCPInstruction extends CPInstruction * Remove variable instruction externalized as a static function in order to allow various * cleanup procedures to use the same codepath as the actual rmVar instruction * - * @param ec - * @param varname - * @throws DMLRuntimeException + * @param ec execution context + * @param varname variable name + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public static void processRemoveVariableInstruction( ExecutionContext ec, String varname ) throws DMLRuntimeException @@ -793,8 +794,9 @@ public class VariableCPInstruction extends CPInstruction /** * Helper function to write CSV files to HDFS. * - * @param ec - * @throws DMLRuntimeException + * @param ec execution context + * @param fname file name + * @throws DMLRuntimeException if DMLRuntimeException occurs */ private void writeCSVFile(ExecutionContext ec, String fname) throws DMLRuntimeException @@ -832,8 +834,10 @@ public class VariableCPInstruction extends CPInstruction /** * Helper function to write MM files to HDFS. - * @param ec - * @throws DMLRuntimeException + * + * @param ec execution context + * @param fname file name + * @throws DMLRuntimeException if DMLRuntimeException occurs */ private void writeMMFile(ExecutionContext ec, String fname) throws DMLRuntimeException @@ -866,7 +870,10 @@ public class VariableCPInstruction extends CPInstruction } /** * Helper function to write scalars to HDFS based on its value type. - * @throws DMLRuntimeException + * + * @param ec execution context + * @param fname file name + * @throws DMLRuntimeException if DMLRuntimeException occurs */ private void writeScalarToHDFS(ExecutionContext ec, String fname) throws DMLRuntimeException @@ -1070,11 +1077,7 @@ public class VariableCPInstruction extends CPInstruction instString = sb.toString(); } } - - /** - * - * @return - */ + public boolean isVariableCastInstruction() { return ( opcode == VariableOperationCode.CastAsScalarVariable || http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/cpfile/ParameterizedBuiltinCPFileInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/cpfile/ParameterizedBuiltinCPFileInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/cpfile/ParameterizedBuiltinCPFileInstruction.java index 7fb1b88..45cc472 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/cpfile/ParameterizedBuiltinCPFileInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/cpfile/ParameterizedBuiltinCPFileInstruction.java @@ -84,12 +84,6 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC super(op, paramsMap, out, opcode, istr); } - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ public static ParameterizedBuiltinCPFileInstruction parseInstruction( String str ) throws DMLRuntimeException { @@ -158,12 +152,7 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC _src = src; _out = out; } - - /** - * - * @return - * @throws DMLRuntimeException - */ + public MatrixObject execute() throws DMLRuntimeException { @@ -233,16 +222,7 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC else return createNewOutputObject(_src, _out, mc.getRows(), ret ); } - - /** - * - * @param src - * @param out - * @param rows - * @param cols - * @return - * @throws DMLRuntimeException - */ + private MatrixObject createNewOutputObject( MatrixObject src, MatrixObject out, long rows, long cols ) throws DMLRuntimeException { @@ -280,13 +260,6 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC return moNew; } - /** - * - * @param fnameOld - * @param stagingDir - * @throws IOException - * @throws DMLRuntimeException - */ public void createTextCellStagingFile( String fnameOld, String stagingDir ) throws IOException, DMLRuntimeException { @@ -342,13 +315,6 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC } } - /** - * - * @param fnameOld - * @param stagingDir - * @throws IOException - * @throws DMLRuntimeException - */ @SuppressWarnings("deprecation") public void createBinaryCellStagingFile( String fnameOld, String stagingDir ) throws IOException, DMLRuntimeException @@ -403,10 +369,11 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC * Creates a binary block staging file and returns if the input matrix is a diag, * because diag is the primary usecase and there is lots of optimization potential. * - * @param fnameOld - * @param stagingDir - * @throws IOException - * @throws DMLRuntimeException + * @param fnameOld old filename + * @param stagingDir staging directory + * @return true if diag + * @throws IOException if IOException occurs + * @throws DMLRuntimeException if DMLRuntimeException occurs */ @SuppressWarnings("deprecation") public boolean createBinaryBlockStagingFile( String fnameOld, String stagingDir ) @@ -448,16 +415,7 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC return diagBlocks; } - - /** - * - * @param dir - * @param buffer - * @param brlen - * @param bclen - * @throws DMLRuntimeException - * @throws IOException - */ + private void appendCellBufferToStagingArea( String dir, LinkedList<Cell> buffer, int brlen, int bclen ) throws DMLRuntimeException, IOException { @@ -483,19 +441,6 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC } } - /** - * - * @param stagingDir - * @param rlen - * @param clen - * @param brlen - * @param bclen - * @param ii - * @return - * @throws FileNotFoundException - * @throws IOException - * @throws DMLRuntimeException - */ private long createKeyMapping( String stagingDir, long rlen, long clen, int brlen, int bclen, InputInfo ii) throws FileNotFoundException, IOException, DMLRuntimeException { @@ -592,19 +537,6 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC return len; } - /** - * - * @param stagingDir - * @param rlen - * @param clen - * @param brlen - * @param bclen - * @param ii - * @return - * @throws FileNotFoundException - * @throws IOException - * @throws DMLRuntimeException - */ private long createKeyMappingDiag( String stagingDir, long rlen, long clen, int brlen, int bclen, InputInfo ii) throws FileNotFoundException, IOException, DMLRuntimeException { @@ -696,19 +628,7 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC return len; } - - /** - * - * @param fnameNew - * @param stagingDir - * @param rlen - * @param clen - * @param brlen - * @param bclen - * @param ii - * @throws IOException - * @throws DMLRuntimeException - */ + @SuppressWarnings("deprecation") public void createCellResultFile( String fnameNew, String stagingDir, long rlen, long clen, int brlen, int bclen, InputInfo ii ) throws IOException, DMLRuntimeException @@ -812,21 +732,7 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC bwriter.close(); } } - - /** - * - * @param fnameNew - * @param stagingDir - * @param rlen - * @param clen - * @param newlen - * @param nnz - * @param brlen - * @param bclen - * @param ii - * @throws IOException - * @throws DMLRuntimeException - */ + @SuppressWarnings("deprecation") public void createBlockResultFile( String fnameNew, String stagingDir, long rlen, long clen, long newlen, long nnz, int brlen, int bclen, InputInfo ii ) throws IOException, DMLRuntimeException @@ -982,21 +888,7 @@ public class ParameterizedBuiltinCPFileInstruction extends ParameterizedBuiltinC writer.close(); } } - - /** - * - * @param fnameNew - * @param stagingDir - * @param rlen - * @param clen - * @param newlen - * @param nnz - * @param brlen - * @param bclen - * @param ii - * @throws IOException - * @throws DMLRuntimeException - */ + @SuppressWarnings("deprecation") public void createBlockResultFileDiag( String fnameNew, String stagingDir, long rlen, long clen, long newlen, long nnz, int brlen, int bclen, InputInfo ii ) throws IOException, DMLRuntimeException http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/gpu/AggregateBinaryGPUInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/gpu/AggregateBinaryGPUInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/gpu/AggregateBinaryGPUInstruction.java index a668607..b9cbfab 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/gpu/AggregateBinaryGPUInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/gpu/AggregateBinaryGPUInstruction.java @@ -54,13 +54,6 @@ public class AggregateBinaryGPUInstruction extends GPUInstruction _isRightTransposed = rightTranspose; } - - /** - * - * @param str - * @return - * @throws DMLRuntimeException - */ public static AggregateBinaryGPUInstruction parseInstruction( String str ) throws DMLRuntimeException { @@ -109,26 +102,13 @@ public class AggregateBinaryGPUInstruction extends GPUInstruction ec.releaseMatrixInputForGPUInstruction(_input2.getName()); ec.releaseMatrixOutputForGPUInstruction(_output.getName()); } - - /** - * - * @param m1 - * @return - * @throws DMLRuntimeException - */ + @SuppressWarnings("unused") private MatrixBlock transpose(MatrixBlock m1) throws DMLRuntimeException { ReorgOperator r_op = new ReorgOperator(SwapIndex.getSwapIndexFnObject(), 1); return (MatrixBlock) (m1.reorgOperations(r_op, new MatrixBlock(), 0, 0, 0)); } - - /** - * - * @param ec - * @param var - * @return - * @throws DMLRuntimeException - */ + @SuppressWarnings("unused") private boolean isSparse(ExecutionContext ec, String var) throws DMLRuntimeException { MatrixObject mo = ec.getMatrixObject(var); http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/gpu/ConvolutionGPUInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/gpu/ConvolutionGPUInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/gpu/ConvolutionGPUInstruction.java index 4626f71..2ac3c9a 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/gpu/ConvolutionGPUInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/gpu/ConvolutionGPUInstruction.java @@ -258,15 +258,7 @@ public class ConvolutionGPUInstruction extends GPUInstruction ec.releaseMatrixInputForGPUInstruction(_input2.getName()); ec.releaseMatrixOutputForGPUInstruction(_output.getName()); } - - /** - * - * @param ec - * @param aL - * @param index - * @return - * @throws DMLRuntimeException - */ + private int getScalarInput(ExecutionContext ec, ArrayList<CPOperand> aL, int index) throws DMLRuntimeException { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/gpu/MMTSJGPUInstruction.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/gpu/MMTSJGPUInstruction.java b/src/main/java/org/apache/sysml/runtime/instructions/gpu/MMTSJGPUInstruction.java index 9ecb93c..b3fdae2 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/gpu/MMTSJGPUInstruction.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/gpu/MMTSJGPUInstruction.java @@ -45,12 +45,14 @@ public class MMTSJGPUInstruction extends GPUInstruction CPOperand _output; /** + * MMTSJGPUInstruction constructor. + * * @param op operator * @param in1 input - * @param type left/right, left-> A' %*% A, right-> A %*% A' + * @param type left/right, left-> A' %*% A, right-> A %*% A' * @param out output - * @param opcode - * @param istr + * @param opcode the opcode + * @param istr ? */ public MMTSJGPUInstruction(Operator op, CPOperand in1, MMTSJType type, CPOperand out, String opcode, String istr) { @@ -63,9 +65,9 @@ public class MMTSJGPUInstruction extends GPUInstruction /** * parse MMTSJ GPU instruction - * @param str - * @return - * @throws DMLRuntimeException + * @param str instruction string + * @return MMTSJGPUInstruction object + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public static MMTSJGPUInstruction parseInstruction ( String str ) throws DMLRuntimeException @@ -87,7 +89,7 @@ public class MMTSJGPUInstruction extends GPUInstruction /** * process MMTSJ GPU instruction * @param ec execution context - * @throws DMLRuntimeException + * @throws DMLRuntimeException if DMLRuntimeException occurs */ @Override public void processInstruction(ExecutionContext ec) @@ -114,7 +116,7 @@ public class MMTSJGPUInstruction extends GPUInstruction /** * returns left/right depending on the type of MMTSJ instruction - * @return _type + * @return MMTSJType object */ public MMTSJType getMMTSJType() { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/gpu/context/GPUContext.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/gpu/context/GPUContext.java b/src/main/java/org/apache/sysml/runtime/instructions/gpu/context/GPUContext.java index 480bf35..06f5f1a 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/gpu/context/GPUContext.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/gpu/context/GPUContext.java @@ -38,7 +38,8 @@ public abstract class GPUContext { /** * Creation / Destruction of GPUContext and related handles - * @return + * + * @return GPU context */ public static GPUContext createGPUContext() { if(currContext == null && DMLScript.USE_ACCELERATOR) { http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/dd8adccb/src/main/java/org/apache/sysml/runtime/instructions/gpu/context/GPUObject.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/sysml/runtime/instructions/gpu/context/GPUObject.java b/src/main/java/org/apache/sysml/runtime/instructions/gpu/context/GPUObject.java index 2a1350f..850e116 100644 --- a/src/main/java/org/apache/sysml/runtime/instructions/gpu/context/GPUObject.java +++ b/src/main/java/org/apache/sysml/runtime/instructions/gpu/context/GPUObject.java @@ -59,19 +59,19 @@ public abstract class GPUObject public abstract void acquireDeviceRead() throws DMLRuntimeException; /** * To signal intent that a matrix block will be written to on the GPU - * @throws DMLRuntimeException + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public abstract void acquireDeviceModifyDense() throws DMLRuntimeException; /** * To signal intent that a sparse matrix block will be written to on the GPU - * @throws DMLRuntimeException + * @throws DMLRuntimeException if DMLRuntimeException occurs */ public abstract void acquireDeviceModifySparse() throws DMLRuntimeException; /** * If memory on GPU has been allocated from elsewhere, this method * updates the internal bookkeeping - * @param numBytes + * @param numBytes number of bytes */ public abstract void setDeviceModify(long numBytes); @@ -83,8 +83,8 @@ public abstract class GPUObject // package-level visibility as these methods are guarded by underlying GPUContext /** * Allocates memory on the GPU - * @param numElemToAllocate number of elements in dense matrix, -1 for unknown or sparse matrix - * @throws DMLRuntimeException + * @param numElemToAllocate number of elements in dense matrix, -1 for unknown or sparse matrix + * @throws DMLRuntimeException if DMLRuntimeException occurs */ abstract void allocateMemoryOnDevice(int numElemToAllocate) throws DMLRuntimeException; abstract void deallocateMemoryOnDevice() throws DMLRuntimeException; @@ -95,10 +95,10 @@ public abstract class GPUObject /** * Copies a matrix block (dense or sparse) from GPU Memory to Host memory. * A {@link MatrixBlock} instance is allocated, data from the GPU is copied in, - * the current one in Host memory is deallocated by calling {@link MatrixObject#acquireModify(MatrixBlock)} + * the current one in Host memory is deallocated by calling MatrixObject's acquireHostModify(MatrixBlock) (??? does not exist) * and overwritten with the newly allocated instance. * TODO : re-examine this to avoid spurious allocations of memory for optimizations - * @throws DMLRuntimeException + * @throws DMLRuntimeException if DMLRuntimeException occurs */ abstract void copyFromDeviceToHost() throws DMLRuntimeException; // Called by export() @@ -107,9 +107,8 @@ public abstract class GPUObject * number of (read) locks that have been obtained on it (reverse order). It repeatedly frees up * blocks on which there are zero locks until the required size has been freed up. * // TODO: update it with hybrid policy - * @param GPUSize Desired size to be freed up on the GPU - * @throws DMLRuntimeException If no blocks to free up or if not enough blocks with zero locks on them. - * @return + * @param GPUSize Desired size to be freed up on the GPU + * @throws DMLRuntimeException If no blocks to free up or if not enough blocks with zero locks on them. */ protected static void evict(final long GPUSize) throws DMLRuntimeException { if(GPUContext.allocatedPointers.size() == 0) {
