natas_hw
/
jidt
mirror of https://github.com/jlizier/jidt
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Cleaned up comments around use of factory method (now not required) for constructing discrete calculators

This commit is contained in:
joseph.lizier 2012-06-13 06:55:05 +00:00
parent 56d868ca00
commit ae5fda1807
8 changed files with 20 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
java/source/infodynamics/measures/discrete/ActiveInformationCalculator.java
View File

@ -32,10 +32,9 @@ public class ActiveInformationCalculator {
private double log_base = 0; private double log_base = 0;
/** /**
* User to create new instances through this factory method. * User was formerly forced to create new instances through this factory method.
* This allows us to return an efficient calculator for * Retained for backwards compatibility.
* base 2, for example, without the user needing to have *
* knowledge of this.
* @param base * @param base
* @param history * @param history
* *
@ -45,7 +44,7 @@ public class ActiveInformationCalculator {
return new ActiveInformationCalculator(base, history); return new ActiveInformationCalculator(base, history);
} }
protected ActiveInformationCalculator(int base, int history) { public ActiveInformationCalculator(int base, int history) {
super(); super();
this.base = base; this.base = base;

7
java/source/infodynamics/measures/discrete/ApparentTransferEntropyCalculator.java
View File

@ -36,10 +36,9 @@ public class ApparentTransferEntropyCalculator extends ContextOfPastMeasureCalcu
protected int startObservationTime = 1; protected int startObservationTime = 1;
/** /**
* User to create new instances through this factory method. * User was formerly forced to create new instances through this factory method.
* This allows us to return an efficient calculator for * Retained for backwards compatibility.
* base 2, for example, without the user needing to have *
* knowledge of this.
* @param base * @param base
* @param history * @param history
* *

6
java/source/infodynamics/measures/discrete/BlockEntropyCalculator.java
View File

@ -28,10 +28,8 @@ public class BlockEntropyCalculator extends EntropyCalculator {
protected int base_power_blocksize = 0; protected int base_power_blocksize = 0;
/** /**
* User to create new instances through this factory method. * User was formerly forced to create new instances through this factory method.
* This allows us to return an efficient calculator for * Retained for backwards compatibility.
* base 2, for example, without the user needing to have
* knowledge of this. (This functionality is now obselete though)
* *
* @param blocksize * @param blocksize
* @param base * @param base

7
java/source/infodynamics/measures/discrete/CompleteTransferEntropyCalculator.java
View File

@ -53,10 +53,9 @@ public class CompleteTransferEntropyCalculator extends InfoMeasureCalculator {
protected int startObservationTime = 1; protected int startObservationTime = 1;
/** /**
* User to create new instances through this factory method. * User was formerly forced to create new instances through this factory method.
* This allows us to return an efficient calculator for * Retained for backwards compatibility.
* base 2, for example, without the user needing to have *
* knowledge of this.
* @param base * @param base
* @param history * @param history
* @param numOtherInfoContributors * @param numOtherInfoContributors

7
java/source/infodynamics/measures/discrete/EntropyCalculator.java
View File

@ -23,10 +23,9 @@ public class EntropyCalculator extends InfoMeasureCalculator
protected int[] stateCount = null; // Count for i[t] protected int[] stateCount = null; // Count for i[t]
/** /**
* User to create new instances through this factory method. * User was formerly forced to create new instances through this factory method.
* This allows us to return an efficient calculator for * Retained for backwards compatibility.
* base 2, for example, without the user needing to have *
* knowledge of this. (This is obselete though)
* @param base * @param base
* @param blocksize * @param blocksize
* *

7
java/source/infodynamics/measures/discrete/EntropyRateCalculator.java
View File

@ -17,10 +17,9 @@ package infodynamics.measures.discrete;
public class EntropyRateCalculator extends SingleAgentMeasureInContextOfPastCalculator { public class EntropyRateCalculator extends SingleAgentMeasureInContextOfPastCalculator {
/** /**
* User to create new instances through this factory method. * User was formerly forced to create new instances through this factory method.
* This allows us to return an efficient calculator for * Retained for backwards compatibility.
* base 2, for example, without the user needing to have *
* knowledge of this. (This is obselete anyway)
* @param base * @param base
* @param history * @param history
* *

2
java/source/infodynamics/measures/discrete/MultiInformationCalculator.java
View File

@ -25,7 +25,7 @@ public class MultiInformationCalculator extends InfoMeasureCalculator {
private boolean checkedFirst = false; private boolean checkedFirst = false;
/** /**
* Null constructor * Constructor
* *
*/ */
public MultiInformationCalculator(int base, int numVars) { public MultiInformationCalculator(int base, int numVars) {

2
java/source/infodynamics/measures/discrete/SeparableInfoCalculator.java
View File

@ -61,7 +61,7 @@ public class SeparableInfoCalculator extends ContextOfPastMeasureCalculator {
/** /**
* User to create new instances through this factory method. * User to create new instances through this factory method.
* This allows us to return an efficient calculator for * 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. * knowledge of this.
* @param base * @param base
* @param history * @param history