Object

infcalcs

EstimateCC

Related Doc: package infcalcs

Permalink

object EstimateCC

Contains functions for generating signal weights and estimating the channel capacity.

Most importantly are the EstimateCC.estimateCC and EstimateCC.estimateCCVerbose functions which are used in the EstCC main object to estimate the channel capacity.

The weighting functions EstimateCC.genUnimodalWeights and EstimateCC.genBimodalWeights generate weights for unimodal and bimodal Gaussian-based probability density functions and EstimateCC.genPieceWiseUniformWeights produces discrete piecewise probability mass functions by iteratively selecting signal values to omit from the mutual information estimation.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EstimateCC
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def calculateWithoutEstimator(data: DRData)(implicit calcConfig: CalcConfig): Unit

    Permalink

    Calculates the mutual information for a set of data with no weights and without the linear regression estimator

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def estimateCC(p: DRData, signalBins: NTuple[Int], index: Int = 0, numConsecBiasedSigEst: Int = 0, optRes: Vector[EstTuple] = Vector())(implicit calcConfig: CalcConfig): Unit

    Permalink

    Estimates the channel capacity for a DRData given a CalcConfig

    Estimates the channel capacity for a DRData given a CalcConfig

    This function generates a list of Weight instances to apply to the data and iterates over signal and response bin numbers as specified in by the configuration parameters to estimate the maximum mutual information.

    Annotations
    @tailrec()
  10. def estimateCCBS(p: DRData, index: Int = 0)(implicit calcConfig: CalcConfig): Unit

    Permalink

    Alternate to estimateCCVerbose for bootstrapped data

  11. def estimateCCVerbose(p: DRData, index: Int = 0)(implicit calcConfig: CalcConfig): Unit

    Permalink

    An imperative equivalent to estimateCC for pretty-printing of calculation status to stdout

    An imperative equivalent to estimateCC for pretty-printing of calculation status to stdout

    returns

    Channel capacity estimate for given list of weights

  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def genBimodalWeights(calcConfig: CalcConfig)(bounds: Tree[Bin], in: List[Double]): List[BWeight]

    Permalink

    Generates list of bimodal weights.

    Generates list of bimodal weights.

    bounds

    Binary Tree of Bin instances

    in

    The input dataset.

    returns

    List of BWeight instances

  14. def genPieceWiseUniformWeights(calcConfig: CalcConfig)(bounds: Tree[Bin]): List[PWeight]

    Permalink

    Generates a set of piece-wise functions to create uniform weighting from bin i to bin j with all outer bins (j) weighted to 0

    Generates a set of piece-wise functions to create uniform weighting from bin i to bin j with all outer bins (j) weighted to 0

    bounds

    Binary Tree of Bin instances

    returns

    List of PWeight instances

  15. def genUniformWeight(calcConfig: CalcConfig)(t: NTuple[Tree[Bin]]): Option[Weight]

    Permalink

    Constructs a joint uniform distribution Weight for all dimensions in signal space

  16. def genUnimodalWeights(calcConfig: CalcConfig)(bounds: Tree[Bin], in: List[Double]): List[GWeight]

    Permalink

    Generates list of unimodal (Gaussian) weights.

    Generates list of unimodal (Gaussian) weights.

    bounds

    Binary Tree of Bin instances

    in

    The input dataset.

    returns

    List of GWeight instances

  17. def genWeights1(sig: Vector[NTuple[Double]], weightFunc: (Tree[Bin], List[Double]) ⇒ List[Weight]): (NTuple[Tree[Bin]]) ⇒ List[Weight]

    Permalink

    Generates a list of weights for n-dim input data

    Generates a list of weights for n-dim input data

    Weights are generated for a n-dim input distribution by calculating the marginal distributions for the n independent random variables representing the signal. These are used to produce a joint distribution (see Weight.makeJoint) in order to construct a list of weights corresponding to the structure of the data set.

    sig

    list of ordered tuples (signal values)

    weightFunc

    function determining calculation of weight distribution

    returns

    list of weights for a signal set of ordered tuples

  18. def genWeights2(sig: Vector[NTuple[Double]], weightFunc: (Tree[Bin]) ⇒ List[Weight]): (NTuple[Tree[Bin]]) ⇒ List[Weight]

    Permalink

    Similar to genWeights1 but with a different weight function signature

  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def getWeights(calcConfig: CalcConfig)(p: DRData, signalBins: NTuple[Int]): List[Option[Weight]]

    Permalink
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped