From 8189116ea4b5db4675e31dfd04a5687d55e29262 Mon Sep 17 00:00:00 2001 From: Eduardo Pedroni Date: Tue, 6 May 2014 14:29:37 +0100 Subject: Added javadocs, made minor changes to the comments --- .../SymbolicRegressionFunctions.NaturalLog.html | 335 +++++++++++++++++++++ 1 file changed, 335 insertions(+) create mode 100644 doc/jcgp/backend/function/SymbolicRegressionFunctions.NaturalLog.html (limited to 'doc/jcgp/backend/function/SymbolicRegressionFunctions.NaturalLog.html') diff --git a/doc/jcgp/backend/function/SymbolicRegressionFunctions.NaturalLog.html b/doc/jcgp/backend/function/SymbolicRegressionFunctions.NaturalLog.html new file mode 100644 index 0000000..d9ce85c --- /dev/null +++ b/doc/jcgp/backend/function/SymbolicRegressionFunctions.NaturalLog.html @@ -0,0 +1,335 @@ + + + + + +SymbolicRegressionFunctions.NaturalLog + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.function
+

Class SymbolicRegressionFunctions.NaturalLog

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    SymbolicRegressionFunctions
    +
    +
    +
    +
    public static class SymbolicRegressionFunctions.NaturalLog
    +extends Function
    +
    Protected natural log function. Returns the natural log of the absolute + value of input 0. If input 0 is less than DoubleArithmetic.DIVISION_LIMIT, + this returns it unchanged.
    +
    +
    See Also:
    +
    Math
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      NaturalLog() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetArity() 
      java.lang.Doublerun(java.lang.Object... args) +
      Executes the function.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NaturalLog

        +
        public NaturalLog()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        public java.lang.Double run(java.lang.Object... args)
        +
        Description copied from class: Function
        +
        Executes the function.
        +
        +
        Specified by:
        +
        run in class Function
        +
        Parameters:
        +
        args - the function arguments.
        +
        Returns:
        +
        the function result.
        +
        +
      • +
      + + + +
        +
      • +

        getArity

        +
        public int getArity()
        +
        +
        Specified by:
        +
        getArity in class Function
        +
        Returns:
        +
        the arity of the function.
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + -- cgit v1.2.3