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

Class SystematicSampling<D extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<?>>

java.lang.Object

ai.libs.jaicore.basic.algorithm.AAlgorithm<D,D>

ai.libs.jaicore.ml.core.filter.sampling.inmemory.ASamplingAlgorithm<D>

ai.libs.jaicore.ml.core.filter.sampling.inmemory.SystematicSampling<D>

All Implemented Interfaces:

java.lang.Iterable<org.api4.java.algorithm.events.IAlgorithmEvent>, java.util.concurrent.Callable<D>, java.util.Iterator<org.api4.java.algorithm.events.IAlgorithmEvent>, org.api4.java.ai.ml.core.filter.unsupervised.sampling.ISamplingAlgorithm<D>, org.api4.java.algorithm.IAlgorithm<D,D>, 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 SystematicSampling<D extends org.api4.java.ai.ml.core.dataset.supervised.ILabeledDataset<?>>
extends ASamplingAlgorithm<D>

Implementation of Systematic Sampling: Sort datapoints and pick every k-th datapoint for the sample.

Field Summary

Fields inherited from class ai.libs.jaicore.ml.core.filter.sampling.inmemory.ASamplingAlgorithm

sample, sampleSize

Constructor Summary

Constructors

Constructor	Description
SystematicSampling(java.util.Random random, D input)	Simple constructor that uses the default datapoint comparator.
SystematicSampling(java.util.Random random, java.util.Comparator<org.api4.java.ai.ml.core.dataset.IInstance> datapointComparator, D input)	Constructor for a custom datapoint comparator.

Method Summary

Modifier and Type	Method	Description
D	getSortedDataset()
org.api4.java.algorithm.events.IAlgorithmEvent	nextWithException()
void	setSortedDataset(D sortedDataset)

Methods inherited from class ai.libs.jaicore.ml.core.filter.sampling.inmemory.ASamplingAlgorithm

call, doInactiveStep, getComplementOfLastSample, getLogger, getLoggerName, getSampleSize, nextSample, setLoggerName, setSampleSize, setSampleSize

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

activate, announceTimeoutDetected, avoidReinterruptionOnShutdownOnCurrentThread, cancel, checkAndConductTermination, checkTermination, computeTimeoutAware, getActivationTime, getConfig, getDeadline, getId, getInput, getListeners, getNumCPUs, getRemainingTimeToDeadline, getState, getTimeout, getTimeoutPrecautionOffset, hasNext, hasThreadBeenInterruptedDuringShutdown, interruptThreadAsPartOfShutdown, isCanceled, isShutdownInitialized, isStopCriterionSatisfied, isTimeoutDefined, isTimeouted, iterator, next, post, registerActiveThread, registerListener, resolveShutdownInterruptOnCurrentThread, setConfig, setDeadline, 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 org.api4.java.algorithm.IAlgorithm

getConfig, getId, getInput, getNumCPUs, getTimeout, registerListener, setMaxNumThreads, setNumCPUs, setTimeout, setTimeout

Methods inherited from interface org.api4.java.common.control.ICancelable

cancel

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Constructor Detail

SystematicSampling

public SystematicSampling(java.util.Random random,
                          D input)

Simple constructor that uses the default datapoint comparator.

Parameters:

random - Random Object for determining the sampling start point.

SystematicSampling

public SystematicSampling(java.util.Random random,
                          java.util.Comparator<org.api4.java.ai.ml.core.dataset.IInstance> datapointComparator,
                          D 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 org.api4.java.algorithm.exceptions.AlgorithmException,
                                                                        java.lang.InterruptedException,
                                                                        org.api4.java.algorithm.exceptions.AlgorithmTimeoutedException,
                                                                        org.api4.java.algorithm.exceptions.AlgorithmExecutionCanceledException

Throws:

org.api4.java.algorithm.exceptions.AlgorithmException

java.lang.InterruptedException

org.api4.java.algorithm.exceptions.AlgorithmTimeoutedException

org.api4.java.algorithm.exceptions.AlgorithmExecutionCanceledException

getSortedDataset

public D getSortedDataset()

setSortedDataset

public void setSortedDataset(D sortedDataset)