You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@systemml.apache.org by de...@apache.org on 2016/11/11 01:31:18 UTC
[2/2] incubator-systemml git commit: [SYSTEMML-842] Javadoc cleanup
in parser, udf, utils, and yarn packages
[SYSTEMML-842] Javadoc cleanup in parser, udf, utils, and yarn 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/234f5af9
Tree: http://git-wip-us.apache.org/repos/asf/incubator-systemml/tree/234f5af9
Diff: http://git-wip-us.apache.org/repos/asf/incubator-systemml/diff/234f5af9
Branch: refs/heads/master
Commit: 234f5af97326ce116501d1eabc8c5035eae2cd59
Parents: 06c5057
Author: Deron Eriksson <de...@us.ibm.com>
Authored: Thu Nov 10 17:18:11 2016 -0800
Committer: Deron Eriksson <de...@us.ibm.com>
Committed: Thu Nov 10 17:18:11 2016 -0800
----------------------------------------------------------------------
.../org/apache/sysml/parser/AParserWrapper.java | 13 +-
.../apache/sysml/parser/BinaryExpression.java | 2 +-
.../sysml/parser/BuiltinFunctionExpression.java | 73 +-----
.../org/apache/sysml/parser/DMLProgram.java | 35 +--
.../org/apache/sysml/parser/DMLTranslator.java | 114 ++++----
.../org/apache/sysml/parser/DataExpression.java | 37 +--
.../org/apache/sysml/parser/DataIdentifier.java | 4 +-
.../org/apache/sysml/parser/Expression.java | 12 +-
.../sysml/parser/ExternalFunctionStatement.java | 3 +-
.../sysml/parser/FunctionCallIdentifier.java | 14 +-
.../sysml/parser/FunctionStatementBlock.java | 2 +-
.../apache/sysml/parser/IndexedIdentifier.java | 8 -
.../apache/sysml/parser/LanguageException.java | 12 -
.../apache/sysml/parser/OutputStatement.java | 18 +-
.../sysml/parser/ParForStatementBlock.java | 134 ++++------
.../ParameterizedBuiltinFunctionExpression.java | 51 ----
.../sysml/parser/RelationalExpression.java | 9 +-
.../java/org/apache/sysml/parser/Statement.java | 7 -
.../org/apache/sysml/parser/StatementBlock.java | 33 ---
.../parser/common/CommonSyntacticValidator.java | 37 +--
.../sysml/parser/dml/DMLParserWrapper.java | 14 +-
.../sysml/parser/pydml/PyDMLParserWrapper.java | 14 +-
.../parser/pydml/PydmlSyntacticValidator.java | 40 ++-
.../sysml/runtime/instructions/Instruction.java | 4 +-
.../java/org/apache/sysml/udf/BinaryObject.java | 4 +-
.../org/apache/sysml/udf/FunctionParameter.java | 4 +-
src/main/java/org/apache/sysml/udf/Matrix.java | 46 ++--
.../org/apache/sysml/udf/PackageFunction.java | 32 +--
src/main/java/org/apache/sysml/udf/Scalar.java | 8 +-
.../sysml/udf/lib/DynamicReadMatrixCP.java | 4 -
.../sysml/udf/lib/DynamicReadMatrixRcCP.java | 4 -
.../sysml/udf/lib/DynamicWriteMatrixCP.java | 4 -
.../org/apache/sysml/udf/lib/GatherWrapper.java | 4 +-
.../org/apache/sysml/udf/lib/OrderWrapper.java | 10 +-
.../sysml/udf/lib/PermutationMatrixWrapper.java | 8 -
.../apache/sysml/udf/lib/RemoveEmptyRows.java | 4 -
.../java/org/apache/sysml/utils/Explain.java | 261 +++----------------
.../InstallDependencyForIntegrationTests.java | 6 +-
.../apache/sysml/utils/ParameterBuilder.java | 4 +-
.../java/org/apache/sysml/utils/Statistics.java | 41 +--
.../org/apache/sysml/yarn/DMLAppMaster.java | 18 +-
.../apache/sysml/yarn/DMLAppMasterUtils.java | 56 +---
.../org/apache/sysml/yarn/DMLYarnClient.java | 70 ++---
.../apache/sysml/yarn/DMLYarnClientProxy.java | 11 +-
.../apache/sysml/yarn/ropt/GridEnumeration.java | 6 -
.../sysml/yarn/ropt/GridEnumerationEqui.java | 4 -
.../sysml/yarn/ropt/GridEnumerationExp.java | 4 -
.../sysml/yarn/ropt/GridEnumerationMemory.java | 21 --
.../apache/sysml/yarn/ropt/ResourceConfig.java | 29 +--
.../sysml/yarn/ropt/ResourceOptimizer.java | 181 ++-----------
.../sysml/yarn/ropt/YarnClusterAnalyzer.java | 90 +++----
.../sysml/yarn/ropt/YarnOptimizerUtils.java | 44 +---
52 files changed, 399 insertions(+), 1269 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/AParserWrapper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/AParserWrapper.java b/src/main/java/org/apache/sysml/parser/AParserWrapper.java
index 6ae299b..4e6ee05 100644
--- a/src/main/java/org/apache/sysml/parser/AParserWrapper.java
+++ b/src/main/java/org/apache/sysml/parser/AParserWrapper.java
@@ -46,24 +46,15 @@ public abstract class AParserWrapper
protected boolean atLeastOneWarning = false;
protected List<ParseIssue> parseIssues;
- /**
- *
- * @param fileName
- * @param dmlScript
- * @param argVals
- * @return
- * @throws ParseException
- */
public abstract DMLProgram parse(String fileName, String dmlScript, Map<String, String> argVals)
throws ParseException;
/**
- * Factory method for creating instances of AParserWrapper, for
- * simplificy fused with the abstract class.
+ * Factory method for creating parser wrappers
*
* @param pydml true if a PyDML parser is needed
- * @return
+ * @return parser wrapper
*/
public static AParserWrapper createParser(boolean pydml)
{
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/BinaryExpression.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/BinaryExpression.java b/src/main/java/org/apache/sysml/parser/BinaryExpression.java
index 0e3dba7..c2f3aec 100644
--- a/src/main/java/org/apache/sysml/parser/BinaryExpression.java
+++ b/src/main/java/org/apache/sysml/parser/BinaryExpression.java
@@ -102,7 +102,7 @@ public class BinaryExpression extends Expression
* Validate parse tree : Process Binary Expression in an assignment
* statement
*
- * @throws LanguageException
+ * @throws LanguageException if LanguageException occurs
*/
@Override
public void validateExpression(HashMap<String, DataIdentifier> ids, HashMap<String, ConstIdentifier> constVars, boolean conditional)
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/BuiltinFunctionExpression.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/BuiltinFunctionExpression.java b/src/main/java/org/apache/sysml/parser/BuiltinFunctionExpression.java
index 0ab2511..ef69a7a 100644
--- a/src/main/java/org/apache/sysml/parser/BuiltinFunctionExpression.java
+++ b/src/main/java/org/apache/sysml/parser/BuiltinFunctionExpression.java
@@ -310,8 +310,9 @@ public class BuiltinFunctionExpression extends DataIdentifier
* Validate parse tree : Process BuiltinFunction Expression in an assignment
* statement
*
- * @throws LanguageException
+ * @throws LanguageException if LanguageException occurs
*/
+ @Override
public void validateExpression(HashMap<String, DataIdentifier> ids, HashMap<String, ConstIdentifier> constVars, boolean conditional)
throws LanguageException {
@@ -1224,21 +1225,10 @@ public class BuiltinFunctionExpression extends DataIdentifier
}
}
- /**
- *
- * @param expr
- * @return
- */
private boolean isConstant(Expression expr) {
return ( expr != null && expr instanceof ConstIdentifier );
}
- /**
- *
- * @param expr
- * @return
- * @throws LanguageException
- */
private double getDoubleValue(Expression expr)
throws LanguageException
{
@@ -1334,11 +1324,6 @@ public class BuiltinFunctionExpression extends DataIdentifier
return result;
}
- /**
- *
- * @param count
- * @throws LanguageException
- */
protected void checkNumParameters(int count) //always unconditional
throws LanguageException
{
@@ -1356,11 +1341,6 @@ public class BuiltinFunctionExpression extends DataIdentifier
}
}
- /**
- *
- * @param e
- * @throws LanguageException
- */
protected void checkMatrixParam(Expression e) //always unconditional
throws LanguageException
{
@@ -1369,11 +1349,6 @@ public class BuiltinFunctionExpression extends DataIdentifier
}
}
- /**
- *
- * @param e
- * @throws LanguageException
- */
protected void checkMatrixFrameParam(Expression e) //always unconditional
throws LanguageException
{
@@ -1382,11 +1357,6 @@ public class BuiltinFunctionExpression extends DataIdentifier
}
}
- /**
- *
- * @param e
- * @throws LanguageException
- */
protected void checkMatrixScalarParam(Expression e) //always unconditional
throws LanguageException
{
@@ -1395,11 +1365,6 @@ public class BuiltinFunctionExpression extends DataIdentifier
}
}
- /**
- *
- * @param e
- * @throws LanguageException
- */
private void checkScalarParam(Expression e) //always unconditional
throws LanguageException
{
@@ -1408,11 +1373,6 @@ public class BuiltinFunctionExpression extends DataIdentifier
}
}
- /**
- *
- * @param e
- * @throws LanguageException
- */
private void checkScalarFrameParam(Expression e) //always unconditional
throws LanguageException
{
@@ -1420,13 +1380,7 @@ public class BuiltinFunctionExpression extends DataIdentifier
raiseValidateError("Expecting scalar parameter for function " + this.getOpCode(), false, LanguageErrorCodes.UNSUPPORTED_PARAMETERS);
}
}
-
- /**
- *
- * @param e
- * @param vt
- * @throws LanguageException
- */
+
private void checkValueTypeParam(Expression e, ValueType vt) //always unconditional
throws LanguageException
{
@@ -1443,11 +1397,6 @@ public class BuiltinFunctionExpression extends DataIdentifier
return (e.getOutput().getDim1() != -1 && e.getOutput().getDim2() != -1);
}
- /**
- *
- * @param e
- * @throws LanguageException
- */
private void check1DMatrixParam(Expression e) //always unconditional
throws LanguageException
{
@@ -1461,24 +1410,12 @@ public class BuiltinFunctionExpression extends DataIdentifier
}
}
- /**
- *
- * @param expr1
- * @param expr2
- * @throws LanguageException
- */
private void checkMatchingDimensions(Expression expr1, Expression expr2)
throws LanguageException
{
checkMatchingDimensions(expr1, expr2, false);
}
- /**
- *
- * @param expr1
- * @param expr2
- * @throws LanguageException
- */
private void checkMatchingDimensions(Expression expr1, Expression expr2, boolean allowsMV)
throws LanguageException
{
@@ -1501,10 +1438,6 @@ public class BuiltinFunctionExpression extends DataIdentifier
}
}
- /**
- *
- * @throws LanguageException
- */
private void checkMatchingDimensionsQuantile()
throws LanguageException
{
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/DMLProgram.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/DMLProgram.java b/src/main/java/org/apache/sysml/parser/DMLProgram.java
index 12a8369..d6a0deb 100644
--- a/src/main/java/org/apache/sysml/parser/DMLProgram.java
+++ b/src/main/java/org/apache/sysml/parser/DMLProgram.java
@@ -84,7 +84,7 @@ public class DMLProgram
*
* @param fkey function key as concatenation of namespace and function name
* (see DMLProgram.constructFunctionKey)
- * @return
+ * @return function statement block
*/
public FunctionStatementBlock getFunctionStatementBlock(String fkey) {
String[] tmp = splitFunctionKey(fkey);
@@ -212,16 +212,6 @@ public class DMLProgram
return rtprog ;
}
- /**
- *
- * @param prog
- * @param sb
- * @param config
- * @return
- * @throws IOException
- * @throws LopsException
- * @throws DMLRuntimeException
- */
public ProgramBlock createRuntimeProgramBlock(Program prog, StatementBlock sb, DMLConfig config)
throws IOException, LopsException, DMLRuntimeException
{
@@ -667,9 +657,9 @@ public class DMLProgram
* Determines if the given program block includes a RMVAR or RMFILEVAR
* instruction for the given varName.
*
- * @param pb
- * @param varName
- * @return
+ * @param pb program block
+ * @param varName variable name
+ * @return true if program block contains remove instruction for variable
*/
private boolean rContainsRMInstruction(ProgramBlock pb, String varName)
{
@@ -724,9 +714,9 @@ public class DMLProgram
* the list of instructions, while for complex program blocks it is added to
* the end of the list of exit instructions.
*
- * @param pb
- * @param inst
- * @throws DMLRuntimeException
+ * @param pb program block
+ * @param inst instruction
+ * @throws DMLRuntimeException if DMLRuntimeException occurs
*/
private void addCleanupInstruction( ProgramBlock pb, Instruction inst )
throws DMLRuntimeException
@@ -767,22 +757,11 @@ public class DMLProgram
}
}
- /**
- *
- * @param fnamespace
- * @param fname
- * @return
- */
public static String constructFunctionKey(String fnamespace, String fname)
{
return fnamespace + Program.KEY_DELIM + fname;
}
- /**
- *
- * @param fkey
- * @return
- */
public static String[] splitFunctionKey(String fkey)
{
return fkey.split(Program.KEY_DELIM);
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/DMLTranslator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/DMLTranslator.java b/src/main/java/org/apache/sysml/parser/DMLTranslator.java
index f3cb0b1..6a3050e 100644
--- a/src/main/java/org/apache/sysml/parser/DMLTranslator.java
+++ b/src/main/java/org/apache/sysml/parser/DMLTranslator.java
@@ -88,8 +88,10 @@ public class DMLTranslator
/**
* Validate parse tree
*
- * @throws LanguageException
- * @throws IOException
+ * @param dmlp dml program
+ * @throws LanguageException if LanguageException occurs
+ * @throws ParseException if ParseException occurs
+ * @throws IOException if IOException occurs
*/
public void validateParseTree(DMLProgram dmlp)
throws LanguageException, ParseException, IOException
@@ -224,7 +226,9 @@ public class DMLTranslator
/**
* Construct Hops from parse tree
*
- * @throws ParseException
+ * @param dmlp dml program
+ * @throws ParseException if ParseException occurs
+ * @throws LanguageException if LanguageException occurs
*/
public void constructHops(DMLProgram dmlp)
throws ParseException, LanguageException
@@ -245,14 +249,7 @@ public class DMLTranslator
constructHops(current);
}
}
-
- /**
- *
- * @param dmlp
- * @throws ParseException
- * @throws LanguageException
- * @throws HopsException
- */
+
public void rewriteHopsDAG(DMLProgram dmlp)
throws ParseException, LanguageException, HopsException
{
@@ -296,13 +293,7 @@ public class DMLTranslator
constructLops(current);
}
}
-
- /**
- *
- * @param sb
- * @throws HopsException
- * @throws LopsException
- */
+
public void constructLops(StatementBlock sb)
throws HopsException, LopsException
{
@@ -1220,9 +1211,9 @@ public class DMLTranslator
/**
* Constructs Hops for a given ForStatementBlock or ParForStatementBlock, respectively.
*
- * @param sb
- * @throws ParseException
- * @throws LanguageException
+ * @param sb for statement block
+ * @throws ParseException if ParseException occurs
+ * @throws LanguageException if LanguageException occurs
*/
public void constructHopsForForControlBlock(ForStatementBlock sb)
throws ParseException, LanguageException
@@ -1362,8 +1353,8 @@ public class DMLTranslator
*
* Method used for both ForStatementBlock and ParForStatementBlock.
*
- * @param passedSB
- * @throws ParseException
+ * @param fsb for statement block
+ * @throws ParseException if ParseException occurs
*/
public void constructHopsForIterablePredicate(ForStatementBlock fsb)
throws ParseException
@@ -1444,7 +1435,11 @@ public class DMLTranslator
* Construct Hops from parse tree : Process Expression in an assignment
* statement
*
- * @throws ParseException
+ * @param source source expression
+ * @param target data identifier
+ * @param hops map of high-level operators
+ * @return high-level operator
+ * @throws ParseException if ParseException occurs
*/
private Hop processExpression(Expression source, DataIdentifier target, HashMap<String, Hop> hops) throws ParseException {
if (source.getKind() == Expression.Kind.BinaryOp) {
@@ -1532,10 +1527,10 @@ public class DMLTranslator
/**
* Constructs the Hops for arbitrary expressions that eventually evaluate to an INT scalar.
*
- * @param source
- * @param hops
- * @return
- * @throws ParseException
+ * @param source source expression
+ * @param hops map of high-level operators
+ * @return high-level operator
+ * @throws ParseException if ParseException occurs
*/
private Hop processTempIntExpression( Expression source, HashMap<String, Hop> hops )
throws ParseException
@@ -1704,7 +1699,11 @@ public class DMLTranslator
* Construct Hops from parse tree : Process Binary Expression in an
* assignment statement
*
- * @throws ParseException
+ * @param source binary expression
+ * @param target data identifier
+ * @param hops map of high-level operators
+ * @return high-level operator
+ * @throws ParseException if ParseException occurs
*/
private Hop processBinaryExpression(BinaryExpression source, DataIdentifier target, HashMap<String, Hop> hops)
throws ParseException
@@ -1794,14 +1793,6 @@ public class DMLTranslator
return currBop;
}
- /**
- *
- * @param source
- * @param target
- * @param hops
- * @return
- * @throws ParseException
- */
private Hop processBooleanExpression(BooleanExpression source, DataIdentifier target, HashMap<String, Hop> hops)
throws ParseException
{
@@ -1898,14 +1889,6 @@ public class DMLTranslator
return new ParameterizedBuiltinOp(name, dt, vt, ParameterizedBuiltinFunctionExpression.pbHopMap.get(op), paramHops);
}
- /**
- *
- * @param source
- * @param targetList
- * @param hops
- * @return
- * @throws ParseException
- */
private Hop processMultipleReturnParameterizedBuiltinFunctionExpression(ParameterizedBuiltinFunctionExpression source, ArrayList<DataIdentifier> targetList,
HashMap<String, Hop> hops) throws ParseException
{
@@ -1950,8 +1933,12 @@ public class DMLTranslator
* Construct Hops from parse tree : Process ParameterizedBuiltinFunction Expression in an
* assignment statement
*
- * @throws ParseException
- * @throws HopsException
+ * @param source parameterized built-in function
+ * @param target data identifier
+ * @param hops map of high-level operators
+ * @return high-level operator
+ * @throws ParseException if ParseException occurs
+ * @throws HopsException if HopsException occurs
*/
private Hop processParameterizedBuiltinFunctionExpression(ParameterizedBuiltinFunctionExpression source, DataIdentifier target,
HashMap<String, Hop> hops) throws ParseException, HopsException {
@@ -2073,8 +2060,12 @@ public class DMLTranslator
* Construct Hops from parse tree : Process ParameterizedExpression in a
* read/write/rand statement
*
- * @throws ParseException
- * @throws HopsException
+ * @param source data expression
+ * @param target data identifier
+ * @param hops map of high-level operators
+ * @return high-level operator
+ * @throws ParseException if ParseException occurs
+ * @throws HopsException if HopsException occurs
*/
private Hop processDataExpression(DataExpression source, DataIdentifier target,
HashMap<String, Hop> hops) throws ParseException, HopsException {
@@ -2157,6 +2148,12 @@ public class DMLTranslator
* Construct HOps from parse tree: process BuiltinFunction Expressions in
* MultiAssignment Statements. For all other builtin function expressions,
* <code>processBuiltinFunctionExpression()</code> is used.
+ *
+ * @param source built-in function expression
+ * @param targetList list of data identifiers
+ * @param hops map of high-level operators
+ * @return high-level operator
+ * @throws ParseException if ParseException occurs
*/
private Hop processMultipleReturnBuiltinFunctionExpression(BuiltinFunctionExpression source, ArrayList<DataIdentifier> targetList,
HashMap<String, Hop> hops) throws ParseException {
@@ -2215,8 +2212,12 @@ public class DMLTranslator
* Construct Hops from parse tree : Process BuiltinFunction Expression in an
* assignment statement
*
- * @throws ParseException
- * @throws HopsException
+ * @param source built-in function expression
+ * @param target data identifier
+ * @param hops map of high-level operators
+ * @return high-level operator
+ * @throws ParseException if ParseException occurs
+ * @throws HopsException if HopsException occurs
*/
private Hop processBuiltinFunctionExpression(BuiltinFunctionExpression source, DataIdentifier target,
HashMap<String, Hop> hops) throws ParseException, HopsException {
@@ -2961,12 +2962,6 @@ public class DMLTranslator
h.setColsInBlock(source.getColsInBlock());
}
- /**
- *
- * @param prog
- * @param pWrites
- * @throws LanguageException
- */
private boolean prepareReadAfterWrite( DMLProgram prog, HashMap<String, DataIdentifier> pWrites )
throws LanguageException
{
@@ -2985,11 +2980,6 @@ public class DMLTranslator
return ret;
}
- /**
- *
- * @param sb
- * @param pWrites
- */
private boolean prepareReadAfterWrite( StatementBlock sb, HashMap<String, DataIdentifier> pWrites )
{
boolean ret = false;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/DataExpression.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/DataExpression.java b/src/main/java/org/apache/sysml/parser/DataExpression.java
index 7bd1c22..f70c1b9 100644
--- a/src/main/java/org/apache/sysml/parser/DataExpression.java
+++ b/src/main/java/org/apache/sysml/parser/DataExpression.java
@@ -547,10 +547,6 @@ public class DataExpression extends DataIdentifier
/**
* Validate parse tree : Process Data Expression in an assignment
* statement
- *
- * @throws LanguageException
- * @throws ParseException
- * @throws IOException
*/
@Override
public void validateExpression(HashMap<String, DataIdentifier> ids, HashMap<String, ConstIdentifier> currConstVars, boolean conditional)
@@ -1687,11 +1683,7 @@ public class DataExpression extends DataIdentifier
}
return;
}
-
- /**
- *
- * @param currConstVars
- */
+
private void performConstantPropagationRand( HashMap<String, ConstIdentifier> currConstVars )
{
//here, we propagate constants for all rand parameters that are required during validate.
@@ -1700,11 +1692,7 @@ public class DataExpression extends DataIdentifier
//replace data identifiers with const identifiers
performConstantPropagation(currConstVars, paramNamesForEval);
}
-
- /**
- *
- * @param currConstVars
- */
+
private void performConstantPropagationReadWrite( HashMap<String, ConstIdentifier> currConstVars )
{
//here, we propagate constants for all read/write parameters that are required during validate.
@@ -1713,12 +1701,7 @@ public class DataExpression extends DataIdentifier
//replace data identifiers with const identifiers
performConstantPropagation(currConstVars, paramNamesForEval);
}
-
- /**
- *
- * @param currConstVars
- * @param paramNames
- */
+
private void performConstantPropagation( HashMap<String, ConstIdentifier> currConstVars, String[] paramNames )
{
for( String paramName : paramNames )
@@ -1912,12 +1895,6 @@ public class DataExpression extends DataIdentifier
}
}
- /**
- *
- * @param filename
- * @return
- * @throws LanguageException
- */
public JSONObject readMetadataFile(String filename, boolean conditional)
throws LanguageException
{
@@ -2159,10 +2136,6 @@ public class DataExpression extends DataIdentifier
// Therefore, one need not actually read the data to infer the format.
}
- /**
- *
- * @return
- */
public boolean isCSVReadWithUnknownSize()
{
boolean ret = false;
@@ -2182,10 +2155,6 @@ public class DataExpression extends DataIdentifier
return ret;
}
- /**
- *
- * @return
- */
public boolean isRead()
{
return (_opcode == DataOp.READ);
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/DataIdentifier.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/DataIdentifier.java b/src/main/java/org/apache/sysml/parser/DataIdentifier.java
index 5538d89..41dffe8 100644
--- a/src/main/java/org/apache/sysml/parser/DataIdentifier.java
+++ b/src/main/java/org/apache/sysml/parser/DataIdentifier.java
@@ -138,7 +138,9 @@ public class DataIdentifier extends Identifier
/**
* Method to specify if an expression returns multiple outputs.
* This method must be overridden by all child classes.
- * @return
+ *
+ * @return true if expression returns multiple outputs
+ * @throws LanguageException if LanguageException occurs
*/
public boolean multipleReturns() throws LanguageException {
throw new LanguageException("multipleReturns() must be overridden in the subclass.");
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/Expression.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/Expression.java b/src/main/java/org/apache/sysml/parser/Expression.java
index bf6b5b9..da30e64 100644
--- a/src/main/java/org/apache/sysml/parser/Expression.java
+++ b/src/main/java/org/apache/sysml/parser/Expression.java
@@ -290,7 +290,7 @@ public abstract class Expression
/**
* Convert string value to relational operator.
*
- * @param val String value ('<', '<=', '>', '>=', '==', '!=')
+ * @param val String value ('<', '<=', '>', '>=', '==', '!=')
* @return Relational operator ({@code RelationalOp.LESS}, {@code RelationalOp.LESSEQUAL},
* {@code RelationalOp.GREATER}, {@code RelationalOp.GREATEREQUAL}, {@code RelationalOp.EQUAL},
* {@code RelationalOp.NOTEQUAL}).
@@ -388,7 +388,7 @@ public abstract class Expression
* @param expression2 Second expression
* @param cast Whether a cast should potentially be performed
* @return The data type ({@link DataType})
- * @throws LanguageException
+ * @throws LanguageException if LanguageException occurs
*/
public static DataType computeDataType(Expression expression1, Expression expression2, boolean cast) throws LanguageException {
return computeDataType(expression1.getOutput(), expression2.getOutput(), cast);
@@ -403,7 +403,7 @@ public abstract class Expression
* @param identifier2 Second identifier
* @param cast Whether a cast should potentially be performed
* @return The data type ({@link DataType})
- * @throws LanguageException
+ * @throws LanguageException if LanguageException occurs
*/
public static DataType computeDataType(Identifier identifier1, Identifier identifier2, boolean cast) throws LanguageException {
DataType d1 = identifier1.getDataType();
@@ -436,7 +436,7 @@ public abstract class Expression
* @param expression2 Second expression
* @param cast Whether a cast should potentially be performed
* @return The value type ({@link ValueType})
- * @throws LanguageException
+ * @throws LanguageException if LanguageException occurs
*/
public static ValueType computeValueType(Expression expression1, Expression expression2, boolean cast) throws LanguageException {
return computeValueType(expression1.getOutput(), expression2.getOutput(), cast);
@@ -452,7 +452,7 @@ public abstract class Expression
* @param identifier2 Second identifier
* @param cast Whether a cast should potentially be performed
* @return The value type ({@link ValueType})
- * @throws LanguageException
+ * @throws LanguageException if LanguageException occurs
*/
public static ValueType computeValueType(Identifier identifier1, Identifier identifier2, boolean cast) throws LanguageException {
ValueType v1 = identifier1.getValueType();
@@ -510,7 +510,7 @@ public abstract class Expression
* Throw a LanguageException with the message.
*
* @param message the error message
- * @throws LanguageException
+ * @throws LanguageException if LanguageException occurs
*/
public void raiseValidateError( String message ) throws LanguageException {
raiseValidateError(message, false, null);
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/ExternalFunctionStatement.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/ExternalFunctionStatement.java b/src/main/java/org/apache/sysml/parser/ExternalFunctionStatement.java
index 4e41dfa..c0a3f31 100644
--- a/src/main/java/org/apache/sysml/parser/ExternalFunctionStatement.java
+++ b/src/main/java/org/apache/sysml/parser/ExternalFunctionStatement.java
@@ -73,7 +73,8 @@ public class ExternalFunctionStatement extends FunctionStatement
/**
* Validates all attributes and attribute values.
*
- * @throws LanguageException
+ * @param sb statement block
+ * @throws LanguageException if LanguageException occurs
*/
public void validateParameters(StatementBlock sb) //always unconditional
throws LanguageException
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/FunctionCallIdentifier.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/FunctionCallIdentifier.java b/src/main/java/org/apache/sysml/parser/FunctionCallIdentifier.java
index 05911dc..297c8ba 100644
--- a/src/main/java/org/apache/sysml/parser/FunctionCallIdentifier.java
+++ b/src/main/java/org/apache/sysml/parser/FunctionCallIdentifier.java
@@ -32,9 +32,9 @@ public class FunctionCallIdentifier extends DataIdentifier
private String _namespace; // namespace of the function being called (null if current namespace is to be used)
/**
- * setFunctionName: sets the function namespace (if specified) and name
- * @param functionName the (optional) namespace information and name of function. If both namespace and name are specified, they are concatinated with "::"
- * @throws ParseException
+ * sets the function namespace (if specified) and name
+ *
+ * @param functionName the (optional) namespace information and name of function. If both namespace and name are specified, they are concatenated with "::"
*/
public void setFunctionName(String functionName) {
_name = functionName;
@@ -97,7 +97,13 @@ public class FunctionCallIdentifier extends DataIdentifier
*
* NOTE: this does not override the normal validateExpression because it needs to pass dmlp!
*
- * @throws LanguageException
+ * @param dmlp dml program
+ * @param ids map of data identifiers
+ * @param constVars map of constant identifiers
+ * @param conditional if true, display warning for 'raiseValidateError'; if false, throw LanguageException
+ * for 'raiseValidateError'
+ * @throws LanguageException if LanguageException occurs
+ * @throws IOException if IOException occurs
*/
public void validateExpression(DMLProgram dmlp, HashMap<String, DataIdentifier> ids, HashMap<String, ConstIdentifier> constVars, boolean conditional)
throws LanguageException, IOException
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/FunctionStatementBlock.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/FunctionStatementBlock.java b/src/main/java/org/apache/sysml/parser/FunctionStatementBlock.java
index 5850d45..cd2bea7 100644
--- a/src/main/java/org/apache/sysml/parser/FunctionStatementBlock.java
+++ b/src/main/java/org/apache/sysml/parser/FunctionStatementBlock.java
@@ -42,7 +42,7 @@ public class FunctionStatementBlock extends StatementBlock
* default values start, they keep going to the right
*
* 2) The other parameters for External Functions
- * @throws IOException
+ *
*/
@Override
public VariableSet validate(DMLProgram dmlProg, VariableSet ids, HashMap<String,ConstIdentifier> constVars, boolean conditional)
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/IndexedIdentifier.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/IndexedIdentifier.java b/src/main/java/org/apache/sysml/parser/IndexedIdentifier.java
index db0bd18..11110b5 100644
--- a/src/main/java/org/apache/sysml/parser/IndexedIdentifier.java
+++ b/src/main/java/org/apache/sysml/parser/IndexedIdentifier.java
@@ -71,14 +71,6 @@ public class IndexedIdentifier extends DataIdentifier
_origDim2 = -1L;
}
- /**
- *
- * @param ids
- * @param currConstVars
- * @param conditional
- * @return
- * @throws LanguageException
- */
public IndexPair calculateIndexedDimensions(HashMap<String,DataIdentifier> ids, HashMap<String, ConstIdentifier> currConstVars, boolean conditional)
throws LanguageException
{
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/LanguageException.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/LanguageException.java b/src/main/java/org/apache/sysml/parser/LanguageException.java
index 9149d4d..8ef06f1 100644
--- a/src/main/java/org/apache/sysml/parser/LanguageException.java
+++ b/src/main/java/org/apache/sysml/parser/LanguageException.java
@@ -29,30 +29,18 @@ public class LanguageException extends DMLException
private static final long serialVersionUID = 1L;
- /**
- * @see java.lang.Exception#Exception()
- */
public LanguageException() {
super();
}
- /**
- * @see java.lang.Exception#Exception(String)
- */
public LanguageException(String message) {
super(message);
}
- /**
- * @see java.lang.Exception#Exception(Throwable)
- */
public LanguageException(Throwable cause) {
super(cause);
}
- /**
- * @see java.lang.Exception#Exception(String, Throwable)
- */
public LanguageException(String message, Throwable cause) {
super(message, cause);
}
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/OutputStatement.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/OutputStatement.java b/src/main/java/org/apache/sysml/parser/OutputStatement.java
index 5cb66e1..aac1b11 100644
--- a/src/main/java/org/apache/sysml/parser/OutputStatement.java
+++ b/src/main/java/org/apache/sysml/parser/OutputStatement.java
@@ -59,16 +59,16 @@ public class OutputStatement extends Statement
}
/**
- * Called by the parser (both javacc and antlr).
+ * Called by the parser.
*
- * @param fname
- * @param fci
- * @param filename
- * @param blp
- * @param bcp
- * @param elp
- * @param ecp
- * @throws DMLParseException
+ * @param fname function name
+ * @param fci function call identifier
+ * @param filename file name
+ * @param blp beginning line position
+ * @param bcp beginning column position
+ * @param elp ending line position
+ * @param ecp ending column position
+ * @throws LanguageException if LanguageException occurs
*/
public OutputStatement(String fname, FunctionCallIdentifier fci,
String filename, int blp, int bcp, int elp, int ecp)
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/ParForStatementBlock.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/ParForStatementBlock.java b/src/main/java/org/apache/sysml/parser/ParForStatementBlock.java
index fb5a8eb..627f1d4 100644
--- a/src/main/java/org/apache/sysml/parser/ParForStatementBlock.java
+++ b/src/main/java/org/apache/sysml/parser/ParForStatementBlock.java
@@ -393,11 +393,6 @@ public class ParForStatementBlock extends ForStatementBlock
return vs;
}
- /**
- *
- * @param sb
- * @return
- */
public ArrayList<String> getReadOnlyParentVars()
{
ArrayList<String> ret = new ArrayList<String>();
@@ -418,8 +413,8 @@ public class ParForStatementBlock extends ForStatementBlock
* Row-wise or column wise partitioning is only suggested if we see pure row-wise or
* column-wise access patterns.
*
- * @param var
- * @return
+ * @param var variables
+ * @return partition format
*/
public PDataPartitionFormat determineDataPartitionFormat(String var)
{
@@ -467,10 +462,10 @@ public class ParForStatementBlock extends ForStatementBlock
* This method recursively determines candidates for output,data,anti dependencies.
* Candidates are defined as writes to non-local variables.
*
- * @param asb
- * @param C
- * @param sCount
- * @throws LanguageException
+ * @param asb list of statement blocks
+ * @param C set of candidates
+ * @param sCount statement count
+ * @throws LanguageException if LanguageException occurs
*/
private void rDetermineCandidates(ArrayList<StatementBlock> asb, HashSet<Candidate> C, Integer sCount)
throws LanguageException
@@ -533,9 +528,10 @@ public class ParForStatementBlock extends ForStatementBlock
* This method recursively determines partitioning candidates for input variables.
* Candidates are defined as index reads of non-local variables.
*
- * @param asb
- * @param C
- * @throws LanguageException
+ * @param var variables
+ * @param asb list of statement blocks
+ * @param C list of partition formats
+ * @throws LanguageException if LanguageException occurs
*/
private void rDeterminePartitioningCandidates(String var, ArrayList<StatementBlock> asb, List<PDataPartitionFormat> C)
throws LanguageException
@@ -586,13 +582,7 @@ public class ParForStatementBlock extends ForStatementBlock
}
}
}
-
- /**
- *
- * @param var
- * @param datsRead
- * @param C
- */
+
private void rDeterminePartitioningCandidates(String var, List<DataIdentifier> datsRead, List<PDataPartitionFormat> C)
{
if( datsRead != null )
@@ -687,12 +677,12 @@ public class ParForStatementBlock extends ForStatementBlock
* (undetected dependency) but potentially false positives (misdetected dependency) can appear.
*
*
- * @param c
- * @param cdt
- * @param asb
- * @param sCount
- * @param dep
- * @throws LanguageException
+ * @param c candidate
+ * @param cdt candidate data type
+ * @param asb list of statement blocks
+ * @param sCount statement count
+ * @param dep array of boolean potential output dependencies
+ * @throws LanguageException if LanguageException occurs
*/
private void rCheckCandidates(Candidate c, DataType cdt, ArrayList<StatementBlock> asb,
Integer sCount, boolean[] dep)
@@ -851,9 +841,9 @@ public class ParForStatementBlock extends ForStatementBlock
/**
* Get all target/source DataIdentifiers of the given statement.
*
- * @param s
- * @param target
- * @return
+ * @param s statement
+ * @param target if true, get targets
+ * @return list of data identifiers
*/
private List<DataIdentifier> getDataIdentifiers(Statement s, boolean target)
{
@@ -988,12 +978,6 @@ public class ParForStatementBlock extends ForStatementBlock
return ret;
}
- /**
- *
- * @param sbs
- * @param flag
- * @throws LanguageException
- */
private void rDetermineBounds( ArrayList<StatementBlock> sbs, boolean flag )
throws LanguageException
{
@@ -1004,10 +988,9 @@ public class ParForStatementBlock extends ForStatementBlock
/**
* Determines the lower/upper bounds of all nested for/parfor indexes.
*
- * @param sbs
+ * @param sb statement block
* @param flag indicates that method is already in subtree of THIS.
- * @return
- * @throws LanguageException
+ * @throws LanguageException if LanguageException occurs
*/
private void rDetermineBounds( StatementBlock sb, boolean flag )
throws LanguageException
@@ -1102,12 +1085,6 @@ public class ParForStatementBlock extends ForStatementBlock
}
}
- /**
- *
- * @param cParent
- * @param cChild
- * @return
- */
private boolean rIsParent( ArrayList<StatementBlock> cParent, StatementBlock cChild)
{
for( StatementBlock sb : cParent )
@@ -1116,13 +1093,7 @@ public class ParForStatementBlock extends ForStatementBlock
return false;
}
-
- /**
- *
- * @param cParent
- * @param cChild
- * @return
- */
+
private boolean rIsParent( StatementBlock cParent, StatementBlock cChild)
{
boolean ret = false;
@@ -1168,10 +1139,10 @@ public class ParForStatementBlock extends ForStatementBlock
* dynamic lower, upper, and increment expressions, and (2) therefore potentially large
* overheads in the general case.
*
- * @param dat1
- * @param dat2
- * @return
- * @throws LanguageException
+ * @param dat1 data identifier 1
+ * @param dat2 data identifier 2
+ * @return true if "anti or data dependency"
+ * @throws LanguageException if LanguageException occurs
*/
private boolean runBanerjeeGCDTest(DataIdentifier dat1, DataIdentifier dat2)
throws LanguageException
@@ -1344,9 +1315,9 @@ public class ParForStatementBlock extends ForStatementBlock
* Runs a constant check for a single data identifier (target of assignment). If constant, then every
* iteration writes to the same cell.
*
- * @param dat1
- * @return
- * @throws LanguageException
+ * @param dat1 data identifier
+ * @return true if dependency
+ * @throws LanguageException if LanguageException occurs
*/
private boolean runConstantCheck(DataIdentifier dat1)
throws LanguageException
@@ -1393,10 +1364,10 @@ public class ParForStatementBlock extends ForStatementBlock
* Runs an equality check for two data identifiers. If equal, there there are no
* inter-iteration (loop-carried) but only intra-iteration dependencies.
*
- * @param dat1
- * @param dat2
- * @return
- * @throws LanguageException
+ * @param dat1 data identifier 1
+ * @param dat2 data identifier 2
+ * @return true if equal data identifiers
+ * @throws LanguageException if LanguageException occurs
*/
private boolean runEqualsCheck(DataIdentifier dat1, DataIdentifier dat2)
throws LanguageException
@@ -1456,9 +1427,9 @@ public class ParForStatementBlock extends ForStatementBlock
* This is the Euclid's algorithm for GCD (greatest common denominator),
* required for the GCD test.
*
- * @param a
- * @param b
- * @return
+ * @param a first value
+ * @param b second value
+ * @return greatest common denominator
*/
private long determineGCD(long a, long b)
{
@@ -1472,9 +1443,9 @@ public class ParForStatementBlock extends ForStatementBlock
* Creates or reuses a linear function for a given data identifier, where identifiers with equal
* names and matrix subscripts result in exactly the same linear function.
*
- * @param dat
- * @return
- * @throws LanguageException
+ * @param dat data identifier
+ * @return linear function
+ * @throws LanguageException if LanguageException occurs
*/
private LinearFunction getLinearFunction(DataIdentifier dat)
throws LanguageException
@@ -1761,8 +1732,8 @@ public class ParForStatementBlock extends ForStatementBlock
* where data identifiers with equal name and matrix subscripts results in equal
* functionIDs.
*
- * @param dat
- * @return
+ * @param dat indexed identifier
+ * @return string function id
*/
private String getFunctionID( IndexedIdentifier dat )
{
@@ -1793,7 +1764,7 @@ public class ParForStatementBlock extends ForStatementBlock
/**
* Removes all zero intercepts created by recursive computation.
*
- * @param f1
+ * @param f1 linear function
*/
private void cleanupFunction( LinearFunction f1 )
{
@@ -1812,8 +1783,8 @@ public class ParForStatementBlock extends ForStatementBlock
* Simply verification check of created linear functions, mainly used for
* robustness purposes.
*
- * @param f1
- * @throws LanguageException
+ * @param f1 linear function
+ * @throws LanguageException if LanguageException occurs
*/
private void verifyFunction(LinearFunction f1)
throws LanguageException
@@ -1844,8 +1815,8 @@ public class ParForStatementBlock extends ForStatementBlock
* Tries to obtain consistent linear functions by forcing the same variable ordering for
* efficient comparison: f2 is modified in a way that it matches the sequence of variables in f1.
*
- * @param f1
- * @param f2
+ * @param f1 linear function 1
+ * @param f2 linear function 2
*/
private void forceConsistency(LinearFunction f1, LinearFunction f2)
{
@@ -1890,9 +1861,9 @@ public class ParForStatementBlock extends ForStatementBlock
* Recursively creates a linear function for a single BinaryExpression, where PLUS, MINUS, MULT
* are allowed as operators.
*
- * @param be
- * @return
- * @throws LanguageException
+ * @param be binary expression
+ * @return linear function
+ * @throws LanguageException if LanguageException occurs
*/
private LinearFunction rParseBinaryExpression(BinaryExpression be)
throws LanguageException
@@ -1988,11 +1959,6 @@ public class ParForStatementBlock extends ForStatementBlock
return ret;
}
- /**
- *
- * @param expr
- * @return
- */
private Long parseLongConstant(Expression expr)
{
Long ret = null;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/ParameterizedBuiltinFunctionExpression.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/ParameterizedBuiltinFunctionExpression.java b/src/main/java/org/apache/sysml/parser/ParameterizedBuiltinFunctionExpression.java
index cce1d77..438c90a 100644
--- a/src/main/java/org/apache/sysml/parser/ParameterizedBuiltinFunctionExpression.java
+++ b/src/main/java/org/apache/sysml/parser/ParameterizedBuiltinFunctionExpression.java
@@ -183,8 +183,6 @@ public class ParameterizedBuiltinFunctionExpression extends DataIdentifier
/**
* Validate parse tree : Process BuiltinFunction Expression in an assignment
* statement
- *
- * @throws LanguageException
*/
@Override
public void validateExpression(HashMap<String, DataIdentifier> ids, HashMap<String, ConstIdentifier> constVars, boolean conditional)
@@ -379,12 +377,6 @@ public class ParameterizedBuiltinFunctionExpression extends DataIdentifier
output.setDimensions(-1, -1);
}
- /**
- *
- * @param output
- * @param conditional
- * @throws LanguageException
- */
private void validateTransformDecode(DataIdentifier output, boolean conditional)
throws LanguageException
{
@@ -401,12 +393,6 @@ public class ParameterizedBuiltinFunctionExpression extends DataIdentifier
output.setDimensions(-1, -1);
}
- /**
- *
- * @param output
- * @param conditional
- * @throws LanguageException
- */
private void validateTransformMeta(DataIdentifier output, boolean conditional)
throws LanguageException
{
@@ -422,12 +408,6 @@ public class ParameterizedBuiltinFunctionExpression extends DataIdentifier
output.setDimensions(-1, -1);
}
- /**
- *
- * @param output
- * @param conditional
- * @throws LanguageException
- */
private void validateTransformEncode(DataIdentifier output1, DataIdentifier output2, boolean conditional)
throws LanguageException
{
@@ -558,12 +538,6 @@ public class ParameterizedBuiltinFunctionExpression extends DataIdentifier
}
- /**
- *
- * @param output
- * @param conditional
- * @throws LanguageException
- */
private void validateGroupedAgg(DataIdentifier output, boolean conditional)
throws LanguageException
{
@@ -753,12 +727,6 @@ public class ParameterizedBuiltinFunctionExpression extends DataIdentifier
return;
}
- /**
- *
- * @param output
- * @param conditional
- * @throws LanguageException
- */
private void validateCastAsString(DataIdentifier output, boolean conditional)
throws LanguageException
{
@@ -784,15 +752,6 @@ public class ParameterizedBuiltinFunctionExpression extends DataIdentifier
output.setDimensions(0, 0);
}
-
- /**
- *
- * @param fname
- * @param pname
- * @param dt
- * @param conditional
- * @throws LanguageException
- */
private void checkDataType( String fname, String pname, DataType dt, boolean conditional )
throws LanguageException
{
@@ -802,17 +761,7 @@ public class ParameterizedBuiltinFunctionExpression extends DataIdentifier
else if( data.getOutput().getDataType() != dt )
raiseValidateError("Input to "+fname+"::"+pname+" must be of type '"+dt.toString()+"'. It is of type '"+data.getOutput().getDataType()+"'.", conditional, LanguageErrorCodes.INVALID_PARAMETERS);
}
-
- /**
- *
- * @param fname
- * @param pname
- * @param dt
- * @param vt
- * @param conditional
- * @throws LanguageException
- */
private void checkDataValueType( String fname, String pname, DataType dt, ValueType vt, boolean conditional )
throws LanguageException
{
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/RelationalExpression.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/RelationalExpression.java b/src/main/java/org/apache/sysml/parser/RelationalExpression.java
index 9dd18a2..19e16ab 100644
--- a/src/main/java/org/apache/sysml/parser/RelationalExpression.java
+++ b/src/main/java/org/apache/sysml/parser/RelationalExpression.java
@@ -96,8 +96,7 @@ public class RelationalExpression extends Expression
}
/**
- * Validate parse tree : Process Relational Expression
- * @throws LanguageException
+ * Validate parse tree : Process Relational Expression
*/
@Override
public void validateExpression(HashMap<String,DataIdentifier> ids, HashMap<String, ConstIdentifier> constVars, boolean conditional)
@@ -172,8 +171,10 @@ public class RelationalExpression extends Expression
/**
* This is same as the function from BuiltinFunctionExpression which is called by ppred
- * @param expr1
- * @param expr2
+ *
+ * @param expr1 expression 1
+ * @param expr2 expression 2
+ * @param allowsMV ?
* @throws LanguageException
*/
private void checkMatchingDimensions(Expression expr1, Expression expr2, boolean allowsMV)
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/Statement.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/Statement.java b/src/main/java/org/apache/sysml/parser/Statement.java
index 532dbfa..8268796 100644
--- a/src/main/java/org/apache/sysml/parser/Statement.java
+++ b/src/main/java/org/apache/sysml/parser/Statement.java
@@ -140,13 +140,6 @@ public abstract class Statement
raiseValidateError(msg, conditional, null);
}
- /**
- *
- * @param msg
- * @param conditional
- * @param code
- * @throws LanguageException
- */
public void raiseValidateError( String msg, boolean conditional, String errorCode )
throws LanguageException
{
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/StatementBlock.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/StatementBlock.java b/src/main/java/org/apache/sysml/parser/StatementBlock.java
index 62278eb..af085d5 100644
--- a/src/main/java/org/apache/sysml/parser/StatementBlock.java
+++ b/src/main/java/org/apache/sysml/parser/StatementBlock.java
@@ -92,9 +92,6 @@ public class StatementBlock extends LiveVariableAnalysis
}
- /**
- * replace statement
- */
public void replaceStatement(int index, Statement passedStmt){
this._statements.set(index, passedStmt);
@@ -246,12 +243,6 @@ public class StatementBlock extends LiveVariableAnalysis
}
- /**
- *
- * @param fblock
- * @param prog
- * @return
- */
private boolean rIsInlineableFunction( FunctionStatementBlock fblock, DMLProgram prog )
{
boolean ret = true;
@@ -533,17 +524,6 @@ public class StatementBlock extends LiveVariableAnalysis
return newStatements;
}
- /**
- *
- * @param dmlProg
- * @param ids
- * @param constVars
- * @param conditional
- * @return
- * @throws LanguageException
- * @throws ParseException
- * @throws IOException
- */
public VariableSet validate(DMLProgram dmlProg, VariableSet ids, HashMap<String, ConstIdentifier> constVars, boolean conditional)
throws LanguageException, ParseException, IOException
{
@@ -971,25 +951,12 @@ public class StatementBlock extends LiveVariableAnalysis
///////////////////////////////////////////////////////////////
// validate error handling (consistent for all expressions)
- /**
- *
- * @param msg
- * @param conditional
- * @throws LanguageException
- */
public void raiseValidateError( String msg, boolean conditional )
throws LanguageException
{
raiseValidateError(msg, conditional, null);
}
- /**
- *
- * @param msg
- * @param conditional
- * @param code
- * @throws LanguageException
- */
public void raiseValidateError( String msg, boolean conditional, String errorCode )
throws LanguageException
{
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/common/CommonSyntacticValidator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/common/CommonSyntacticValidator.java b/src/main/java/org/apache/sysml/parser/common/CommonSyntacticValidator.java
index 83f7823..bcdeffd 100644
--- a/src/main/java/org/apache/sysml/parser/common/CommonSyntacticValidator.java
+++ b/src/main/java/org/apache/sysml/parser/common/CommonSyntacticValidator.java
@@ -51,7 +51,6 @@ import org.apache.sysml.parser.PrintStatement;
import org.apache.sysml.parser.RelationalExpression;
import org.apache.sysml.parser.Statement;
import org.apache.sysml.parser.StringIdentifier;
-import org.apache.sysml.parser.dml.DmlParser.BuiltinFunctionExpressionContext;
import org.apache.sysml.parser.dml.DmlSyntacticValidator;
import org.apache.sysml.parser.pydml.PydmlSyntacticValidator;
@@ -580,36 +579,38 @@ public abstract class CommonSyntacticValidator {
/**
* Converts PyDML/DML built in functions to a common format for the runtime.
- * @param ctx
+ * @param ctx antlr rule context
* @param namespace Namespace of the function
* @param functionName Name of the builtin function
* @param paramExpression Array of parameter names and values
* @param fnName Token of the built in function identifier
- * @return
+ * @return common syntax format for runtime
*/
protected abstract ConvertedDMLSyntax convertToDMLSyntax(ParserRuleContext ctx, String namespace, String functionName, ArrayList<ParameterExpression> paramExpression,
Token fnName);
/**
- * Function overridden for DML & PyDML that handles any language specific builtin functions
- * @param ctx
- * @param functionName
- * @param paramExpressions
- * @return instance of {@link Expression}
+ * Function overridden for DML & PyDML that handles any language specific builtin functions
+ * @param ctx antlr rule context
+ * @param functionName Name of the builtin function
+ * @param paramExpressions Array of parameter names and values
+ * @return instance of {@link Expression}
*/
protected abstract Expression handleLanguageSpecificFunction(ParserRuleContext ctx, String functionName, ArrayList<ParameterExpression> paramExpressions);
/** Checks for builtin functions and does Action 'f'.
- * <br/>
+ * <p>
* Constructs the
* appropriate {@link AssignmentStatement} from
- * {@link CommonSyntacticValidator#functionCallAssignmentStatementHelper(ParserRuleContext, Set, Set, Expression, StatementInfo, Token, Token, String, String, ArrayList, boolean)
+ * {@link CommonSyntacticValidator#functionCallAssignmentStatementHelper(ParserRuleContext, Set, Set, Expression, StatementInfo, Token, Token, String, String, ArrayList, boolean)}
* or Assign to {@link Expression} from
- * {@link DmlSyntacticValidator#exitBuiltinFunctionExpression(BuiltinFunctionExpressionContext)}
- *
- * @param ctx
- * @param functionName
- * @param paramExpressions
+ * DmlSyntacticValidator's exitBuiltinFunctionExpression(BuiltinFunctionExpressionContext).
+ * </p>
+ *
+ * @param ctx antlr rule context
+ * @param functionName Name of the builtin function
+ * @param paramExpressions Array of parameter names and values
+ * @param f action to perform
* @return true if a builtin function was found
*/
protected boolean buildForBuiltInFunction(ParserRuleContext ctx, String functionName, ArrayList<ParameterExpression> paramExpressions, Action f) {
@@ -724,7 +725,7 @@ public abstract class CommonSyntacticValidator {
/**
* To allow for different actions in
- * {@link CommonSyntacticValidator#functionCallAssignmentStatementHelper(ParserRuleContext, Set, Set, Expression, StatementInfo, Token, Token, String, String, ArrayList)}
+ * {@link CommonSyntacticValidator#functionCallAssignmentStatementHelper(ParserRuleContext, Set, Set, Expression, StatementInfo, Token, Token, String, String, ArrayList, boolean)}
*/
public static interface Action {
public void execute(Expression e);
@@ -743,8 +744,8 @@ public abstract class CommonSyntacticValidator {
/**
* Indicates if the given data type string is a valid data type.
*
- * @param datatype
- * @param start
+ * @param datatype data type (matrix, frame, or scalar)
+ * @param start antlr token
*/
protected void checkValidDataType(String datatype, Token start) {
boolean validMatrixType =
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/dml/DMLParserWrapper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/dml/DMLParserWrapper.java b/src/main/java/org/apache/sysml/parser/dml/DMLParserWrapper.java
index 25c6c6d..9c070d8 100644
--- a/src/main/java/org/apache/sysml/parser/dml/DMLParserWrapper.java
+++ b/src/main/java/org/apache/sysml/parser/dml/DMLParserWrapper.java
@@ -77,11 +77,11 @@ public class DMLParserWrapper extends AParserWrapper
/**
* Parses the passed file with command line parameters. You can either pass both (local file) or just dmlScript (hdfs) or just file name (import command)
- * @param fileName either full path or null --> only used for better error handling
- * @param dmlScript required
- * @param argVals
- * @return
- * @throws ParseException
+ * @param fileName either full path or null --> only used for better error handling
+ * @param dmlScript script file contents
+ * @param argVals script arguments
+ * @return dml program, or null if error
+ * @throws ParseException if ParseException occurs
*/
@Override
public DMLProgram parse(String fileName, String dmlScript, Map<String,String> argVals) throws ParseException {
@@ -96,8 +96,8 @@ public class DMLParserWrapper extends AParserWrapper
* @param dmlScript script file contents
* @param sourceNamespace namespace from source statement
* @param argVals script arguments
- * @return null if at least one error
- * @throws ParseException
+ * @return dml program, or null if at least one error
+ * @throws ParseException if ParseException occurs
*/
public DMLProgram doParse(String fileName, String dmlScript, String sourceNamespace, Map<String,String> argVals) throws ParseException {
DMLProgram dmlPgm = null;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/pydml/PyDMLParserWrapper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/pydml/PyDMLParserWrapper.java b/src/main/java/org/apache/sysml/parser/pydml/PyDMLParserWrapper.java
index e98df38..2799bc4 100644
--- a/src/main/java/org/apache/sysml/parser/pydml/PyDMLParserWrapper.java
+++ b/src/main/java/org/apache/sysml/parser/pydml/PyDMLParserWrapper.java
@@ -61,11 +61,11 @@ public class PyDMLParserWrapper extends AParserWrapper
/**
* Parses the passed file with command line parameters. You can either pass both (local file) or just dmlScript (hdfs) or just file name (import command)
- * @param fileName either full path or null --> only used for better error handling
- * @param dmlScript required
- * @param argVals
- * @return
- * @throws ParseException
+ * @param fileName either full path or null --> only used for better error handling
+ * @param dmlScript script file contents
+ * @param argVals script arguments
+ * @return dml program, or null if error
+ * @throws ParseException if ParseException occurs
*/
@Override
public DMLProgram parse(String fileName, String dmlScript, Map<String,String> argVals) throws ParseException {
@@ -80,8 +80,8 @@ public class PyDMLParserWrapper extends AParserWrapper
* @param dmlScript script file contents
* @param sourceNamespace namespace from source statement
* @param argVals script arguments
- * @return null if at least one error
- * @throws ParseException
+ * @return dml program, or null if at least one error
+ * @throws ParseException if ParseException occurs
*/
public DMLProgram doParse(String fileName, String dmlScript, String sourceNamespace, Map<String,String> argVals) throws ParseException {
DMLProgram dmlPgm = null;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/parser/pydml/PydmlSyntacticValidator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/parser/pydml/PydmlSyntacticValidator.java b/src/main/java/org/apache/sysml/parser/pydml/PydmlSyntacticValidator.java
index b7626dc..cc886cd 100644
--- a/src/main/java/org/apache/sysml/parser/pydml/PydmlSyntacticValidator.java
+++ b/src/main/java/org/apache/sysml/parser/pydml/PydmlSyntacticValidator.java
@@ -19,6 +19,14 @@
package org.apache.sysml.parser.pydml;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
import org.antlr.v4.runtime.ParserRuleContext;
import org.antlr.v4.runtime.Token;
import org.antlr.v4.runtime.tree.ErrorNode;
@@ -58,8 +66,6 @@ import org.apache.sysml.parser.common.CommonSyntacticValidator;
import org.apache.sysml.parser.common.CustomErrorListener;
import org.apache.sysml.parser.common.ExpressionInfo;
import org.apache.sysml.parser.common.StatementInfo;
-import org.apache.sysml.parser.dml.DmlParser.MatrixMulExpressionContext;
-import org.apache.sysml.parser.dml.DmlSyntacticValidator;
import org.apache.sysml.parser.pydml.PydmlParser.AddSubExpressionContext;
import org.apache.sysml.parser.pydml.PydmlParser.AssignmentStatementContext;
import org.apache.sysml.parser.pydml.PydmlParser.AtomicExpressionContext;
@@ -110,14 +116,6 @@ import org.apache.sysml.parser.pydml.PydmlParser.UnaryExpressionContext;
import org.apache.sysml.parser.pydml.PydmlParser.ValueDataTypeCheckContext;
import org.apache.sysml.parser.pydml.PydmlParser.WhileStatementContext;
-import java.io.File;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
/**
* TODO: Refactor duplicated parser code dml/pydml (entire package).
*
@@ -438,9 +436,9 @@ public class PydmlSyntacticValidator extends CommonSyntacticValidator implements
* Increment lower indices by 1 when translating from PyDML
* (0-based indexing) to DML (1-based indexing).
*
- * @param expr
- * @param ctx
- * @return
+ * @param expr expression
+ * @param ctx antlr rule context
+ * @return expression
*/
private Expression incrementByOne(Expression expr, ParserRuleContext ctx) {
// Addition and subtraction operator same as DML
@@ -575,7 +573,7 @@ public class PydmlSyntacticValidator extends CommonSyntacticValidator implements
// -----------------------------------------------------------------
/** Similar to the "axis" argument in numpy.
- * @param ctx
+ * @param ctx parameter expression
* @return 0 (along rows), 1 (along column) or -1 (for error)
*/
private int getAxis(ParameterExpression ctx) {
@@ -653,12 +651,12 @@ public class PydmlSyntacticValidator extends CommonSyntacticValidator implements
/**
* Check function name, namespace, parameters (#params & possible values) and produce useful messages/hints
- * @param ctx
- * @param namespace
- * @param functionName
- * @param paramExpression
- * @param fnName
- * @return
+ * @param ctx antlr rule context
+ * @param namespace Namespace of the function
+ * @param functionName Name of the builtin function
+ * @param paramExpression Array of parameter names and values
+ * @param fnName Token of the builtin function identifier
+ * @return common syntax format for runtime
*/
private ConvertedDMLSyntax convertPythonBuiltinFunctionToDMLSyntax(ParserRuleContext ctx, String namespace, String functionName, ArrayList<ParameterExpression> paramExpression,
Token fnName) {
@@ -1094,7 +1092,7 @@ public class PydmlSyntacticValidator extends CommonSyntacticValidator implements
* For Pydml, matrix multiply is invoked using dot (A, B). This is taken from numpy.dot
* For Dml, it is invoked using "%*%". The dot function call in pydml is converted to a
* {@link BinaryExpression} equivalent to what is done in
- * {@link DmlSyntacticValidator#exitMatrixMulExpression(MatrixMulExpressionContext)}
+ * DmlSyntacticValidator's exitMatrixMulExpression(MatrixMulExpressionContext).
*/
@Override
protected Expression handleLanguageSpecificFunction(ParserRuleContext ctx, String functionName, ArrayList<ParameterExpression> paramExpression){
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/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 c02c64f..7676317 100644
--- a/src/main/java/org/apache/sysml/runtime/instructions/Instruction.java
+++ b/src/main/java/org/apache/sysml/runtime/instructions/Instruction.java
@@ -215,8 +215,8 @@ public abstract class Instruction
/**
* This method should be used to execute the instruction.
*
- * @param ec
- * @throws DMLRuntimeException
+ * @param ec execution context
+ * @throws DMLRuntimeException if DMLRuntimeException occurs
*/
public abstract void processInstruction(ExecutionContext ec)
throws DMLRuntimeException;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/BinaryObject.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/BinaryObject.java b/src/main/java/org/apache/sysml/udf/BinaryObject.java
index ba87c4e..8fb2f8f 100644
--- a/src/main/java/org/apache/sysml/udf/BinaryObject.java
+++ b/src/main/java/org/apache/sysml/udf/BinaryObject.java
@@ -33,7 +33,7 @@ public class BinaryObject extends FunctionParameter
/**
* constructor that takes object as param
*
- * @param o
+ * @param o object
*/
public BinaryObject(Object o) {
super( FunctionParameterType.Object );
@@ -43,7 +43,7 @@ public class BinaryObject extends FunctionParameter
/**
* Method to retrieve object.
*
- * @return
+ * @return object
*/
public Object getObject() {
return _o;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/FunctionParameter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/FunctionParameter.java b/src/main/java/org/apache/sysml/udf/FunctionParameter.java
index 58e486b..a45065c 100644
--- a/src/main/java/org/apache/sysml/udf/FunctionParameter.java
+++ b/src/main/java/org/apache/sysml/udf/FunctionParameter.java
@@ -46,7 +46,7 @@ public abstract class FunctionParameter implements Serializable
/**
* Constructor to set type
*
- * @param type
+ * @param type function parameter type
*/
public FunctionParameter(FunctionParameterType type) {
_type = type;
@@ -55,7 +55,7 @@ public abstract class FunctionParameter implements Serializable
/**
* Method to get type
*
- * @return
+ * @return function parameter type
*/
public FunctionParameterType getType() {
return _type;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/Matrix.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/Matrix.java b/src/main/java/org/apache/sysml/udf/Matrix.java
index 98f1d4b..0dcbb54 100644
--- a/src/main/java/org/apache/sysml/udf/Matrix.java
+++ b/src/main/java/org/apache/sysml/udf/Matrix.java
@@ -62,9 +62,9 @@ public class Matrix extends FunctionParameter
* with a default filename of ExternalFunctionProgramBlockCP and hence, should only
* be used by CP external functions.
*
- * @param rows
- * @param cols
- * @param vType
+ * @param rows number of rows
+ * @param cols number of columns
+ * @param vType value type
*/
public Matrix(long rows, long cols, ValueType vType) {
this( ExternalFunctionProgramBlockCP.DEFAULT_FILENAME,
@@ -75,10 +75,10 @@ public class Matrix extends FunctionParameter
* Constructor that takes matrix file path, num rows, num cols, and matrix
* value type as parameters.
*
- * @param path
- * @param rows
- * @param cols
- * @param vType
+ * @param path file path
+ * @param rows number of rows
+ * @param cols number of columns
+ * @param vType value type
*/
public Matrix(String path, long rows, long cols, ValueType vType) {
super(FunctionParameterType.Matrix);
@@ -101,7 +101,7 @@ public class Matrix extends FunctionParameter
/**
* Method to get file path for matrix.
*
- * @return
+ * @return file path
*/
public String getFilePath() {
return _filePath;
@@ -110,7 +110,7 @@ public class Matrix extends FunctionParameter
/**
* Method to get the number of rows in the matrix.
*
- * @return
+ * @return number of rows
*/
public long getNumRows() {
return _rows;
@@ -119,7 +119,7 @@ public class Matrix extends FunctionParameter
/**
* Method to get the number of cols in the matrix.
*
- * @return
+ * @return number of columns
*/
public long getNumCols() {
@@ -129,7 +129,7 @@ public class Matrix extends FunctionParameter
/**
* Method to get value type for this matrix.
*
- * @return
+ * @return value type
*/
public ValueType getValueType() {
return _vType;
@@ -140,9 +140,9 @@ public class Matrix extends FunctionParameter
* user knows the matrix fits in memory. We are using the dense
* representation.
*
- * @return
- * @throws DMLRuntimeException
- * @throws IOException
+ * @return matrix as two-dimensional double array
+ * @throws DMLRuntimeException if DMLRuntimeException occurs
+ * @throws IOException if IOException occurs
*/
public double[][] getMatrixAsDoubleArray()
throws DMLRuntimeException, IOException
@@ -169,9 +169,9 @@ public class Matrix extends FunctionParameter
* user knows the matrix fits in memory. We are using the dense
* representation.
*
- * @return
- * @throws IOException
- * @throws DMLRuntimeException
+ * @param data matrix as 2-dimensional double array
+ * @throws IOException if IOException occurs
+ * @throws DMLRuntimeException if DMLRuntimeException occurs
*/
public void setMatrixDoubleArray(double[][] data /*, OutputInfo oinfo, InputInfo iinfo*/)
throws IOException, DMLRuntimeException
@@ -185,9 +185,9 @@ public class Matrix extends FunctionParameter
* user knows the matrix fits in memory. We are using the dense
* representation.
*
- * @return
- * @throws IOException
- * @throws DMLRuntimeException
+ * @param data matrix as double array
+ * @throws IOException if IOException occurs
+ * @throws DMLRuntimeException if DMLRuntimeException occurs
*/
public void setMatrixDoubleArray(double[] data /*, OutputInfo oinfo, InputInfo iinfo*/)
throws IOException, DMLRuntimeException
@@ -201,8 +201,10 @@ public class Matrix extends FunctionParameter
* user knows the matrix fits in memory. We are using the dense
* representation.
*
- * @return
- * @throws IOException
+ * @param mb matrix block
+ * @param oinfo output info
+ * @param iinfo input info
+ * @throws IOException if IOException occurs
*/
public void setMatrixDoubleArray(MatrixBlock mb, OutputInfo oinfo, InputInfo iinfo)
throws IOException
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/PackageFunction.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/PackageFunction.java b/src/main/java/org/apache/sysml/udf/PackageFunction.java
index 3c01553..44ff86b 100644
--- a/src/main/java/org/apache/sysml/udf/PackageFunction.java
+++ b/src/main/java/org/apache/sysml/udf/PackageFunction.java
@@ -52,7 +52,7 @@ public abstract class PackageFunction implements Serializable
/**
* Method to get the number of inputs to this package function.
*
- * @return
+ * @return number of inputs
*/
public final int getNumFunctionInputs() {
if (_function_inputs == null)
@@ -64,8 +64,8 @@ public abstract class PackageFunction implements Serializable
/**
* Method to get a specific input to this package function.
*
- * @param pos
- * @return
+ * @param pos input position
+ * @return function parameter
*/
public final FunctionParameter getFunctionInput(int pos) {
if (_function_inputs == null || _function_inputs.size() <= pos)
@@ -78,7 +78,7 @@ public abstract class PackageFunction implements Serializable
* Method to get the number of outputs of this package function. This method
* should be implemented in the user's function.
*
- * @return
+ * @return number of outputs
*/
public abstract int getNumFunctionOutputs();
@@ -86,15 +86,15 @@ public abstract class PackageFunction implements Serializable
* Method to get a specific output of this package function. This method
* should be implemented in the user's function.
*
- * @param pos
- * @return
+ * @param pos function position
+ * @return function parameter
*/
public abstract FunctionParameter getFunctionOutput(int pos);
/**
* Method to set the number of inputs for this package function
*
- * @param numInputs
+ * @param numInputs number of inputs
*/
public final void setNumFunctionInputs(int numInputs) {
if (_function_inputs == null)
@@ -111,8 +111,8 @@ public abstract class PackageFunction implements Serializable
/**
* Method to set a specific input for this package function
*
- * @param input
- * @param pos
+ * @param input function parameter input
+ * @param pos input position
*/
public final void setInput(FunctionParameter input, int pos) {
if (_function_inputs == null || _function_inputs.size() <= pos)
@@ -125,7 +125,7 @@ public abstract class PackageFunction implements Serializable
/**
* Method to set the configuration file for this function.
*
- * @param fName
+ * @param fName configuration file name
*/
public final void setConfiguration(String fName) {
_configurationFile = fName;
@@ -134,24 +134,16 @@ public abstract class PackageFunction implements Serializable
/**
* Method to get the configuration file name
*
- * @return
+ * @return configuration file name
*/
public final String getConfiguration() {
return _configurationFile;
}
-
- /**
- *
- * @param dir
- */
+
public void setBaseDir(String dir) {
_baseDir = dir;
}
- /**
- *
- * @return
- */
public String getBaseDir() {
return _baseDir;
}
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/Scalar.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/Scalar.java b/src/main/java/org/apache/sysml/udf/Scalar.java
index 7be664f..a738da5 100644
--- a/src/main/java/org/apache/sysml/udf/Scalar.java
+++ b/src/main/java/org/apache/sysml/udf/Scalar.java
@@ -41,8 +41,8 @@ public class Scalar extends FunctionParameter
/**
* Constructor to setup a scalar object.
*
- * @param t
- * @param val
+ * @param t scalar value type
+ * @param val value
*/
public Scalar(ScalarValueType t, String val) {
super(FunctionParameterType.Scalar);
@@ -53,7 +53,7 @@ public class Scalar extends FunctionParameter
/**
* Method to get type of scalar.
*
- * @return
+ * @return scalar value type
*/
public ScalarValueType getScalarType() {
return _sType;
@@ -62,7 +62,7 @@ public class Scalar extends FunctionParameter
/**
* Method to get value for scalar.
*
- * @return
+ * @return scalar value
*/
public String getValue() {
return _value;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/lib/DynamicReadMatrixCP.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/lib/DynamicReadMatrixCP.java b/src/main/java/org/apache/sysml/udf/lib/DynamicReadMatrixCP.java
index c386021..793e9de 100644
--- a/src/main/java/org/apache/sysml/udf/lib/DynamicReadMatrixCP.java
+++ b/src/main/java/org/apache/sysml/udf/lib/DynamicReadMatrixCP.java
@@ -30,10 +30,6 @@ import org.apache.sysml.udf.PackageFunction;
import org.apache.sysml.udf.Scalar;
import org.apache.sysml.udf.Matrix.ValueType;
-/**
- *
- *
- */
public class DynamicReadMatrixCP extends PackageFunction
{
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/lib/DynamicReadMatrixRcCP.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/lib/DynamicReadMatrixRcCP.java b/src/main/java/org/apache/sysml/udf/lib/DynamicReadMatrixRcCP.java
index 6077885..188d337 100644
--- a/src/main/java/org/apache/sysml/udf/lib/DynamicReadMatrixRcCP.java
+++ b/src/main/java/org/apache/sysml/udf/lib/DynamicReadMatrixRcCP.java
@@ -31,10 +31,6 @@ import org.apache.sysml.udf.Scalar;
import org.apache.sysml.udf.Matrix.ValueType;
import org.apache.sysml.udf.Scalar.ScalarValueType;
-/**
- *
- *
- */
public class DynamicReadMatrixRcCP extends PackageFunction
{
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/lib/DynamicWriteMatrixCP.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/lib/DynamicWriteMatrixCP.java b/src/main/java/org/apache/sysml/udf/lib/DynamicWriteMatrixCP.java
index 1674a2e..96ba4d9 100644
--- a/src/main/java/org/apache/sysml/udf/lib/DynamicWriteMatrixCP.java
+++ b/src/main/java/org/apache/sysml/udf/lib/DynamicWriteMatrixCP.java
@@ -30,10 +30,6 @@ import org.apache.sysml.udf.PackageFunction;
import org.apache.sysml.udf.Scalar;
import org.apache.sysml.udf.Scalar.ScalarValueType;
-/**
- *
- *
- */
@Deprecated
public class DynamicWriteMatrixCP extends PackageFunction
{
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/lib/GatherWrapper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/lib/GatherWrapper.java b/src/main/java/org/apache/sysml/udf/lib/GatherWrapper.java
index 748d120..63786b8 100644
--- a/src/main/java/org/apache/sysml/udf/lib/GatherWrapper.java
+++ b/src/main/java/org/apache/sysml/udf/lib/GatherWrapper.java
@@ -28,14 +28,14 @@ import org.apache.sysml.udf.Matrix.ValueType;
/**
* Wrapper class for conversions of bit vectors to condensed position vectors.
* The semantics are equivalent to the following dml snippet:
- * # bitvector into position vector, e.g., 1011 -> 1034
+ * # bitvector into position vector, e.g., 1011 -> 1034
* Bv = seq(1,nrow(B)) * B;
* # gather positions into condensed vector
* V = removeEmpty(target=Bv, margin="rows");
*
* Note that the inverse operation would be a scatter that can be implemented
* via the following dml snippet:
- * # position vector into bit vector, e.g., 1034 -> 1011
+ * # position vector into bit vector, e.g., 1034 -> 1011
* B = table( V, 1 );
*/
public class GatherWrapper extends PackageFunction
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/lib/OrderWrapper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/lib/OrderWrapper.java b/src/main/java/org/apache/sysml/udf/lib/OrderWrapper.java
index cca6c4d..8686ddc 100644
--- a/src/main/java/org/apache/sysml/udf/lib/OrderWrapper.java
+++ b/src/main/java/org/apache/sysml/udf/lib/OrderWrapper.java
@@ -83,10 +83,6 @@ public class OrderWrapper extends PackageFunction
}
}
- /**
- *
- *
- */
private static class AscRowComparator implements Comparator<double[]>
{
private int _col = -1;
@@ -102,11 +98,7 @@ public class OrderWrapper extends PackageFunction
return (arg0[_col] < arg1[_col] ? -1 : (arg0[_col] == arg1[_col] ? 0 : 1));
}
}
-
- /**
- *
- *
- */
+
private static class DescRowComparator implements Comparator<double[]>
{
private int _col = -1;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/lib/PermutationMatrixWrapper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/lib/PermutationMatrixWrapper.java b/src/main/java/org/apache/sysml/udf/lib/PermutationMatrixWrapper.java
index c4ce0c6..845d92e 100644
--- a/src/main/java/org/apache/sysml/udf/lib/PermutationMatrixWrapper.java
+++ b/src/main/java/org/apache/sysml/udf/lib/PermutationMatrixWrapper.java
@@ -116,10 +116,6 @@ public class PermutationMatrixWrapper extends PackageFunction
}
}
- /**
- *
- *
- */
private static class AscRowComparator implements Comparator<double[]> {
private int _col = -1;
@@ -134,10 +130,6 @@ public class PermutationMatrixWrapper extends PackageFunction
}
}
- /**
- *
- *
- */
private static class DescRowComparator implements Comparator<double[]> {
private int _col = -1;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/234f5af9/src/main/java/org/apache/sysml/udf/lib/RemoveEmptyRows.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/udf/lib/RemoveEmptyRows.java b/src/main/java/org/apache/sysml/udf/lib/RemoveEmptyRows.java
index 046b7b2..b45d225 100644
--- a/src/main/java/org/apache/sysml/udf/lib/RemoveEmptyRows.java
+++ b/src/main/java/org/apache/sysml/udf/lib/RemoveEmptyRows.java
@@ -42,10 +42,6 @@ import org.apache.sysml.udf.Matrix;
import org.apache.sysml.udf.PackageFunction;
import org.apache.sysml.udf.Matrix.ValueType;
-/**
- *
- *
- */
@Deprecated
public class RemoveEmptyRows extends PackageFunction
{