org.nd4j.linalg.api.buffer

Class BufferReaper

java.lang.Object

java.lang.Thread

org.nd4j.linalg.api.buffer.BufferReaper

All Implemented Interfaces:

Runnable

public class BufferReaper
extends Thread

Buffer reaper for handling freeing of resources related to buffers. NDArrays themselves are lightweight objects that tend to be referenced for GC early, but the buffers often stick around. The solution is as follows: Given an ndarrays's id, pass the id as a referencing item to the buffer.

The buffer knows what items are referencing it without directly holding a reference to the object itself.

The major reason we need to do this is because of how reference counting works.

When we do reference counting, we don't want the garbage collector to be tricked in to thinking that the object is still being used when in reality its a circular reference. This id mechanism allows tracking while still allowing the GC to properly mark items for collection.

Author:

Adam Gibson

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
BufferReaper(ReferenceQueue<INDArray> queue, ReferenceQueue<DataBuffer> buffer)
BufferReaper(Runnable target, ReferenceQueue<INDArray> queue, ReferenceQueue<DataBuffer> buffer)
BufferReaper(Runnable target, String name, ReferenceQueue<INDArray> queue, ReferenceQueue<DataBuffer> buffer)
BufferReaper(String name, ReferenceQueue<INDArray> queue, ReferenceQueue<DataBuffer> buffer)
BufferReaper(ThreadGroup group, Runnable target, ReferenceQueue<INDArray> queue, ReferenceQueue<DataBuffer> buffer)
BufferReaper(ThreadGroup group, Runnable target, String name, long stackSize, ReferenceQueue<INDArray> queue, ReferenceQueue<DataBuffer> buffer)
BufferReaper(ThreadGroup group, Runnable target, String name, ReferenceQueue<INDArray> queue, ReferenceQueue<DataBuffer> buffer)
BufferReaper(ThreadGroup group, String name, ReferenceQueue<INDArray> queue, ReferenceQueue<DataBuffer> buffer)

Method Summary

Modifier and Type	Method and Description
static void	destroy(INDArray... arrs) Frees data used by the given ndarrays
void	run()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferReaper

public BufferReaper(ReferenceQueue<INDArray> queue,
                    ReferenceQueue<DataBuffer> buffer)

BufferReaper

public BufferReaper(Runnable target,
                    ReferenceQueue<INDArray> queue,
                    ReferenceQueue<DataBuffer> buffer)

BufferReaper

public BufferReaper(ThreadGroup group,
                    Runnable target,
                    ReferenceQueue<INDArray> queue,
                    ReferenceQueue<DataBuffer> buffer)

BufferReaper

public BufferReaper(String name,
                    ReferenceQueue<INDArray> queue,
                    ReferenceQueue<DataBuffer> buffer)

BufferReaper

public BufferReaper(ThreadGroup group,
                    String name,
                    ReferenceQueue<INDArray> queue,
                    ReferenceQueue<DataBuffer> buffer)

BufferReaper

public BufferReaper(Runnable target,
                    String name,
                    ReferenceQueue<INDArray> queue,
                    ReferenceQueue<DataBuffer> buffer)

BufferReaper

public BufferReaper(ThreadGroup group,
                    Runnable target,
                    String name,
                    ReferenceQueue<INDArray> queue,
                    ReferenceQueue<DataBuffer> buffer)

BufferReaper

public BufferReaper(ThreadGroup group,
                    Runnable target,
                    String name,
                    long stackSize,
                    ReferenceQueue<INDArray> queue,
                    ReferenceQueue<DataBuffer> buffer)

Method Detail

destroy

public static void destroy(INDArray... arrs)

Frees data used by the given ndarrays

Parameters:

arrs - the arrays to free

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread