Package ai.libs.jaicore.ml.core.filter.sampling.infiles

Class SystematicFileSampling

  • All Implemented Interfaces:
    java.lang.Iterable<org.api4.java.algorithm.events.IAlgorithmEvent>, java.util.concurrent.Callable<java.io.File>, java.util.Iterator<org.api4.java.algorithm.events.IAlgorithmEvent>, org.api4.java.algorithm.IAlgorithm<java.io.File,​java.io.File>, org.api4.java.common.control.ICancelable, org.api4.java.common.control.ILoggingCustomizable, org.api4.java.common.event.IEventEmitter<java.lang.Object>, org.api4.java.common.event.IRelaxedEventEmitter
    public class SystematicFileSampling
extends AFileSamplingAlgorithm
    File-level implementation of Systematic Sampling: Sort datapoints and pick every k-th datapoint for the sample.

    • Constructor Summary

      Constructors 
      Constructor Description
      SystematicFileSampling​(java.util.Random random, java.io.File input)
      Simple constructor that uses the default datapoint comparator.
      SystematicFileSampling​(java.util.Random random, java.util.Comparator<java.lang.String> datapointComparator, java.io.File input)
      Constructor for a custom datapoint comparator.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cancel()  
      protected void cleanUp()
      Implement custom clean up behaviour.
      org.api4.java.algorithm.events.IAlgorithmEvent nextWithException()  

      • Methods inherited from class ai.libs.jaicore.basic.algorithm.AAlgorithm

        activate, announceTimeoutDetected, avoidReinterruptionOnShutdownOnCurrentThread, checkAndConductTermination, checkTermination, computeTimeoutAware, getActivationTime, getConfig, getDeadline, getId, getInput, getListeners, getLoggerName, getNumCPUs, getRemainingTimeToDeadline, getState, getTimeout, getTimeoutPrecautionOffset, hasNext, hasThreadBeenInterruptedDuringShutdown, interruptThreadAsPartOfShutdown, isCanceled, isShutdownInitialized, isStopCriterionSatisfied, isTimeoutDefined, isTimeouted, iterator, next, post, registerActiveThread, registerListener, resolveShutdownInterruptOnCurrentThread, setConfig, setDeadline, setLoggerName, setMaxNumThreads, setNumCPUs, setState, setTimeout, setTimeout, setTimeoutPrecautionOffset, shutdown, terminate, unregisterActiveThread, unregisterThreadAndShutdown

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

      • Methods inherited from interface java.util.Iterator

        forEachRemaining, remove

    • Constructor Detail

      • SystematicFileSampling

        public SystematicFileSampling​(java.util.Random random,
                              java.io.File input)
        Simple constructor that uses the default datapoint comparator.
        Parameters:
        random - Random Object for determining the sampling start point.

      • SystematicFileSampling

        public SystematicFileSampling​(java.util.Random random,
                              java.util.Comparator<java.lang.String> datapointComparator,
                              java.io.File input)
        Constructor for a custom datapoint comparator.
        Parameters:
        random - Random Object for determining the sampling start point.
        datapointComparator - Comparator to sort the dataset.

    • Method Detail

      • nextWithException

        public org.api4.java.algorithm.events.IAlgorithmEvent nextWithException()
                                                                 throws java.lang.InterruptedException,
                                                                        org.api4.java.algorithm.exceptions.AlgorithmExecutionCanceledException,
                                                                        org.api4.java.algorithm.exceptions.AlgorithmException,
                                                                        org.api4.java.algorithm.exceptions.AlgorithmTimeoutedException
        Throws:
        java.lang.InterruptedException
        org.api4.java.algorithm.exceptions.AlgorithmExecutionCanceledException
        org.api4.java.algorithm.exceptions.AlgorithmException
        org.api4.java.algorithm.exceptions.AlgorithmTimeoutedException

      • cancel

        public void cancel()
        Specified by:
        cancel in interface org.api4.java.common.control.ICancelable
        Overrides:
        cancel in class ai.libs.jaicore.basic.algorithm.AAlgorithm<java.io.File,​java.io.File>