Packages

trait ApproximationAssertion[-T] extends AnyRef

Trait for unit testing approximation outputs with an error rate(in percentage).

A simple test might look like this:

import com.spotify.scio.testing.PipelineSpec
import com.spotify.scio.testing.ApproximationAssertions._

class ApproximatePipelineTest extends PipelineSpec {
  "An approximate  pipeline" should "in range with error percentage" in {
    val input: Seq[Int] = ...
    val estimator = ZetaSketchHllPlusPlus[Int](20) // with precision 20
    val output: Seq[Long] = runWithData(input) { sCol =>
      sCol.countApproxDistinct(estimator)
    }
    output shouldApproximate withErrorRate(Seq(3L), 0.5d)
  }

  it should "works with key-valued output" in {
    val in: Seq[(String, Int)] = ...
    val expected: Seq[(String, Long)] = ...
    val estimator = ZetaSketchHllPlusPlus[Int]() // with default precision
    val output = runWithData(in) { scl =>
      scl
        .countApproxDistinctByKey(estimator)
    }
    output shouldApproximate withErrorRatePerKey(expected, 0.5d)
  }
}
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ApproximationAssertion
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def assert(value: T): Assertion

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped