diff options
author | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-06 14:29:37 +0100 |
---|---|---|
committer | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-06 14:29:37 +0100 |
commit | 8189116ea4b5db4675e31dfd04a5687d55e29262 (patch) | |
tree | c1815021452a888f8838f1628d8fb4689777e73e /src/jcgp/backend/function | |
parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'src/jcgp/backend/function')
3 files changed, 13 insertions, 12 deletions
diff --git a/src/jcgp/backend/function/DigitalCircuitFunctions.java b/src/jcgp/backend/function/DigitalCircuitFunctions.java index 0d4ae8e..a217eb7 100644 --- a/src/jcgp/backend/function/DigitalCircuitFunctions.java +++ b/src/jcgp/backend/function/DigitalCircuitFunctions.java @@ -5,16 +5,16 @@ package jcgp.backend.function; * (defined as unsigned integer functions in the classic * CGP implementation) defined in static nested classes. * <br> - * This is the function set used by DigitalCircuitProblem. + * This is the function set used by {@code DigitalCircuitProblem}. * - * @see DigitalCircuiProblem + * @see jcgp.backend.modules.problem.DigitalCircuitProblem * @author Eduardo Pedroni * */ public class DigitalCircuitFunctions extends FunctionSet { /** - * Creates a new instance of DigitalCircuitFunctions. + * Creates a new instance of {@code DigitalCircuitFunctions}. */ public DigitalCircuitFunctions() { registerFunctions( diff --git a/src/jcgp/backend/function/SymbolicRegressionFunctions.java b/src/jcgp/backend/function/SymbolicRegressionFunctions.java index 9c6a3b1..a4750fc 100644 --- a/src/jcgp/backend/function/SymbolicRegressionFunctions.java +++ b/src/jcgp/backend/function/SymbolicRegressionFunctions.java @@ -1,5 +1,7 @@ package jcgp.backend.function; +import jcgp.backend.modules.problem.SymbolicRegressionProblem; + /** * This class contains all symbolic regression functions * (defined as double functions in the classic CGP implementation) @@ -180,7 +182,7 @@ public class SymbolicRegressionFunctions extends FunctionSet { /** * Protected tangent function, in radians. Returns the tangent of input 0. - * If input 0 is less than {@link DoubleArithmetic.}DIVISION_LIMIT, + * If input 0 is less than {@code DoubleArithmetic.DIVISION_LIMIT}, * this returns it unchanged. * * @see Math @@ -317,7 +319,7 @@ public class SymbolicRegressionFunctions extends FunctionSet { /** * Protected natural log function. Returns the natural log of the absolute - * value of input 0. If input 0 is less than {@link DoubleArithmetic.}DIVISION_LIMIT, + * value of input 0. If input 0 is less than {@code DoubleArithmetic.DIVISION_LIMIT}, * this returns it unchanged. * * @see Math @@ -346,7 +348,7 @@ public class SymbolicRegressionFunctions extends FunctionSet { /** * Protected log base 10 function. Returns the log to base 10 the absolute - * value of input 0. If input 0 is less than {@link DoubleArithmetic.}DIVISION_LIMIT, + * value of input 0. If input 0 is less than {@code DoubleArithmetic.DIVISION_LIMIT}, * this returns it unchanged. * * @see Math diff --git a/src/jcgp/backend/function/TravellingSalesmanFunctions.java b/src/jcgp/backend/function/TravellingSalesmanFunctions.java index 06b44bb..8a326b5 100644 --- a/src/jcgp/backend/function/TravellingSalesmanFunctions.java +++ b/src/jcgp/backend/function/TravellingSalesmanFunctions.java @@ -3,9 +3,8 @@ package jcgp.backend.function; /** * This class contains all travelling salesman functions in static nested classes. * <br> - * This is the function set used by TravellingSalesmanProblem. + * This is the function set to be used by TravellingSalesmanProblem. * - * @see TravellingSalesmanProblem * @author Eduardo Pedroni * */ @@ -113,7 +112,7 @@ public class TravellingSalesmanFunctions extends FunctionSet { /** * Scaled exponential function. Returns the exponential of input 0 - * scaled to the range 0 < x < 1. + * scaled to the range 0 < x > 1. * * @see Math */ @@ -228,7 +227,7 @@ public class TravellingSalesmanFunctions extends FunctionSet { /** * Scaled hypotenuse function. Returns the square root of input 0 squared - * plus input 1 squared, scaled to the range 0 < x < 1. + * plus input 1 squared, scaled to the range 0 < x > 1. * * @see Math */ @@ -257,7 +256,7 @@ public class TravellingSalesmanFunctions extends FunctionSet { /** * Scaled addition returns the sum of inputs 0 and 1 scaled - * to the range 0 < x < 1. + * to the range 0 < x > 1. * */ public static class ScaledAddition extends Function { @@ -285,7 +284,7 @@ public class TravellingSalesmanFunctions extends FunctionSet { /** * Symmetric subtraction returns the absolute difference between inputs 0 and 1, - * scaled to the range 0 < x < 1. + * scaled to the range 0 <; x > 1. * */ public static class SymmetricSubtraction extends Function { |