Class

io.github.edouardfouche.index

CorrectedRankIndex

Related Doc: package index

Permalink

class CorrectedRankIndex extends Index

Compute an adjusted, corrected rank index from a given data set The rank are adjusted, which means that in the case of ties, the rank is defined as the average rank of the tying values Also, a "correction for ties" is computed, as required to compute a Mann-Whitney U test The correction is computed as a cumulative value.

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

Instance Constructors

  1. new CorrectedRankIndex(values: Array[Array[Double]], parallelize: Int = 0)

    Permalink

    values

    A row-oriented data set

    parallelize

    Whether to parallelize or not the index computation (beta)

Type Members

  1. type T = (Int, Float, Double)

    Permalink
    Definition Classes
    CorrectedRankIndexIndex

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. def allSlice(dimensions: Set[Int], sliceSize: Int): Array[Boolean]

    Permalink
    Definition Classes
    CorrectedRankIndexIndex
  5. def apply(n: Int): Array[T]

    Permalink
    Definition Classes
    Index
  6. def areCoPrimes(a: Int, b: Int): Boolean

    Permalink

    Coprimality test between two integers a and b

    Coprimality test between two integers a and b

    a

    integer

    b

    integer

    returns

    boolean, true if a and b are coprimes

    Definition Classes
    Index
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def closeSearch(a: Int, inc: Int = 1): Stream[Int]

    Permalink

    Helper function that generates a stream of integers that are close to a, shall not be smaller than 1

    Helper function that generates a stream of integers that are close to a, shall not be smaller than 1

    a

    starting integer

    inc

    increment (internal parameter with default value 1)

    returns

    A stream of integer close to a and greater or equal to 1

    Definition Classes
    Index
  10. def createIndex(input: Array[Array[Double]]): Array[Array[T]]

    Permalink

    returns

    An index, which is also column-oriented

    Definition Classes
    CorrectedRankIndexIndex
  11. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def findClosestCoPrime(a: Int, ref: Int): Int

    Permalink

    Find the closest integer from a, which is coprime with ref

    Find the closest integer from a, which is coprime with ref

    a

    An integer. We want to find the closest coprime from this position

    ref

    A reference integer.

    returns

    The cloest integer from a which is coprime with ref

    Definition Classes
    Index
  15. final def gcd(a: Int, b: Int): Int

    Permalink

    Find the greatest common divisor of a and b

    Find the greatest common divisor of a and b

    a

    integer

    b

    integer

    returns

    An integer, the greatest common divisor of a and b

    Definition Classes
    Index
    Annotations
    @tailrec()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def getSafeCut(cut: Int, reference: Int): Int

    Permalink
    Definition Classes
    CorrectedRankIndexIndex
  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  19. val index: Array[Array[T]]

    Permalink
    Definition Classes
    Index
  20. def indices: Range

    Permalink
    Definition Classes
    Index
  21. def isEmpty: Boolean

    Permalink
    Definition Classes
    Index
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def mean(xs: Array[Int]): Float

    Permalink
    Definition Classes
    Index
  24. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  27. def numCols: Int

    Permalink
    Definition Classes
    Index
  28. def numRows: Int

    Permalink
    Definition Classes
    Index
  29. val parallelize: Int

    Permalink

    Whether to parallelize or not the index computation (beta)

    Whether to parallelize or not the index computation (beta)

    Definition Classes
    CorrectedRankIndexIndex
  30. def randomSlice(dimensions: Set[Int], referenceDim: Int, sliceSize: Int): Array[Boolean]

    Permalink

    Produce a subspace slice by conditioning on all dimensions, except a reference dimension

    Produce a subspace slice by conditioning on all dimensions, except a reference dimension

    dimensions

    The set of dimensions of the subspaces

    referenceDim

    The dimension that is considered as reference

    sliceSize

    The size of the slice for each dimensions, determined by alpha

    returns

    Returns an array of booleans. True corresponds to indexes included in the slice.

    Definition Classes
    CorrectedRankIndexIndex
  31. def randomUniformSlice(dimensions: Set[Int], referenceDim: Int, sliceSize: Int): Array[Boolean]

    Permalink
  32. def restrictedRandomSlice(dimensions: Set[Int], referenceDim: Int, alpha: Double): Array[Boolean]

    Permalink
    Definition Classes
    CorrectedRankIndexIndex
  33. def restrictedSafeRandomSlice(dimensions: Set[Int], referenceDim: Int, alpha: Double): Array[Boolean]

    Permalink
    Definition Classes
    CorrectedRankIndexIndex
  34. def safeSlice(dimensions: Set[Int], referenceDim: Int, sliceSize: Int): Array[Boolean]

    Permalink
    Definition Classes
    CorrectedRankIndexIndex
  35. def simpleSlice(dimension: Int, sliceSize: Int): CorrectedRankIndex.this.type

    Permalink
    Definition Classes
    CorrectedRankIndexIndex
  36. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  38. val values: Array[Array[Double]]

    Permalink

    A row-oriented data set

    A row-oriented data set

    Definition Classes
    CorrectedRankIndexIndex
  39. final def wait(): Unit

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

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

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

Inherited from Index

Inherited from AnyRef

Inherited from Any

Ungrouped