From ae5fda1807ebca565ee0dc256842ea6580186d6b Mon Sep 17 00:00:00 2001 From: "joseph.lizier" Date: Wed, 13 Jun 2012 06:55:05 +0000 Subject: [PATCH] Cleaned up comments around use of factory method (now not required) for constructing discrete calculators --- .../measures/discrete/ActiveInformationCalculator.java | 9 ++++----- .../discrete/ApparentTransferEntropyCalculator.java | 7 +++---- .../measures/discrete/BlockEntropyCalculator.java | 6 ++---- .../discrete/CompleteTransferEntropyCalculator.java | 7 +++---- .../measures/discrete/EntropyCalculator.java | 7 +++---- .../measures/discrete/EntropyRateCalculator.java | 7 +++---- .../measures/discrete/MultiInformationCalculator.java | 2 +- .../measures/discrete/SeparableInfoCalculator.java | 2 +- 8 files changed, 20 insertions(+), 27 deletions(-) diff --git a/java/source/infodynamics/measures/discrete/ActiveInformationCalculator.java b/java/source/infodynamics/measures/discrete/ActiveInformationCalculator.java index 76cd51f..d5ce5c0 100755 --- a/java/source/infodynamics/measures/discrete/ActiveInformationCalculator.java +++ b/java/source/infodynamics/measures/discrete/ActiveInformationCalculator.java @@ -32,10 +32,9 @@ public class ActiveInformationCalculator { private double log_base = 0; /** - * User to create new instances through this factory method. - * This allows us to return an efficient calculator for - * base 2, for example, without the user needing to have - * knowledge of this. + * User was formerly forced to create new instances through this factory method. + * Retained for backwards compatibility. + * * @param base * @param history * @@ -45,7 +44,7 @@ public class ActiveInformationCalculator { return new ActiveInformationCalculator(base, history); } - protected ActiveInformationCalculator(int base, int history) { + public ActiveInformationCalculator(int base, int history) { super(); this.base = base; diff --git a/java/source/infodynamics/measures/discrete/ApparentTransferEntropyCalculator.java b/java/source/infodynamics/measures/discrete/ApparentTransferEntropyCalculator.java index f1edfb1..a2f70e9 100755 --- a/java/source/infodynamics/measures/discrete/ApparentTransferEntropyCalculator.java +++ b/java/source/infodynamics/measures/discrete/ApparentTransferEntropyCalculator.java @@ -36,10 +36,9 @@ public class ApparentTransferEntropyCalculator extends ContextOfPastMeasureCalcu protected int startObservationTime = 1; /** - * User to create new instances through this factory method. - * This allows us to return an efficient calculator for - * base 2, for example, without the user needing to have - * knowledge of this. + * User was formerly forced to create new instances through this factory method. + * Retained for backwards compatibility. + * * @param base * @param history * diff --git a/java/source/infodynamics/measures/discrete/BlockEntropyCalculator.java b/java/source/infodynamics/measures/discrete/BlockEntropyCalculator.java index 6238551..faa6d92 100755 --- a/java/source/infodynamics/measures/discrete/BlockEntropyCalculator.java +++ b/java/source/infodynamics/measures/discrete/BlockEntropyCalculator.java @@ -28,10 +28,8 @@ public class BlockEntropyCalculator extends EntropyCalculator { protected int base_power_blocksize = 0; /** - * User to create new instances through this factory method. - * This allows us to return an efficient calculator for - * base 2, for example, without the user needing to have - * knowledge of this. (This functionality is now obselete though) + * User was formerly forced to create new instances through this factory method. + * Retained for backwards compatibility. * * @param blocksize * @param base diff --git a/java/source/infodynamics/measures/discrete/CompleteTransferEntropyCalculator.java b/java/source/infodynamics/measures/discrete/CompleteTransferEntropyCalculator.java index 52f7f45..a8ddf00 100755 --- a/java/source/infodynamics/measures/discrete/CompleteTransferEntropyCalculator.java +++ b/java/source/infodynamics/measures/discrete/CompleteTransferEntropyCalculator.java @@ -53,10 +53,9 @@ public class CompleteTransferEntropyCalculator extends InfoMeasureCalculator { protected int startObservationTime = 1; /** - * User to create new instances through this factory method. - * This allows us to return an efficient calculator for - * base 2, for example, without the user needing to have - * knowledge of this. + * User was formerly forced to create new instances through this factory method. + * Retained for backwards compatibility. + * * @param base * @param history * @param numOtherInfoContributors diff --git a/java/source/infodynamics/measures/discrete/EntropyCalculator.java b/java/source/infodynamics/measures/discrete/EntropyCalculator.java index 241f801..b8239b7 100755 --- a/java/source/infodynamics/measures/discrete/EntropyCalculator.java +++ b/java/source/infodynamics/measures/discrete/EntropyCalculator.java @@ -23,10 +23,9 @@ public class EntropyCalculator extends InfoMeasureCalculator protected int[] stateCount = null; // Count for i[t] /** - * User to create new instances through this factory method. - * This allows us to return an efficient calculator for - * base 2, for example, without the user needing to have - * knowledge of this. (This is obselete though) + * User was formerly forced to create new instances through this factory method. + * Retained for backwards compatibility. + * * @param base * @param blocksize * diff --git a/java/source/infodynamics/measures/discrete/EntropyRateCalculator.java b/java/source/infodynamics/measures/discrete/EntropyRateCalculator.java index e6b4ccb..da57c04 100755 --- a/java/source/infodynamics/measures/discrete/EntropyRateCalculator.java +++ b/java/source/infodynamics/measures/discrete/EntropyRateCalculator.java @@ -17,10 +17,9 @@ package infodynamics.measures.discrete; public class EntropyRateCalculator extends SingleAgentMeasureInContextOfPastCalculator { /** - * User to create new instances through this factory method. - * This allows us to return an efficient calculator for - * base 2, for example, without the user needing to have - * knowledge of this. (This is obselete anyway) + * User was formerly forced to create new instances through this factory method. + * Retained for backwards compatibility. + * * @param base * @param history * diff --git a/java/source/infodynamics/measures/discrete/MultiInformationCalculator.java b/java/source/infodynamics/measures/discrete/MultiInformationCalculator.java index 9872c2e..6b19397 100755 --- a/java/source/infodynamics/measures/discrete/MultiInformationCalculator.java +++ b/java/source/infodynamics/measures/discrete/MultiInformationCalculator.java @@ -25,7 +25,7 @@ public class MultiInformationCalculator extends InfoMeasureCalculator { private boolean checkedFirst = false; /** - * Null constructor + * Constructor * */ public MultiInformationCalculator(int base, int numVars) { diff --git a/java/source/infodynamics/measures/discrete/SeparableInfoCalculator.java b/java/source/infodynamics/measures/discrete/SeparableInfoCalculator.java index 62e3d00..f1e0bbc 100755 --- a/java/source/infodynamics/measures/discrete/SeparableInfoCalculator.java +++ b/java/source/infodynamics/measures/discrete/SeparableInfoCalculator.java @@ -61,7 +61,7 @@ public class SeparableInfoCalculator extends ContextOfPastMeasureCalculator { /** * User to create new instances through this factory method. * This allows us to return an efficient calculator for - * base 2, for example, without the user needing to have + * particular situations without the user needing to have * knowledge of this. * @param base * @param history