org.bytedeco.caffe

Class FloatBlob

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.caffe.FloatBlob

All Implemented Interfaces:

AutoCloseable

@Name(value="caffe::Blob<float>")
 @NoOffset
 @Properties(inherit=caffe.class)
public class FloatBlob
extends Pointer

\brief A wrapper around SyncedMemory holders serving as the basic computational unit through which Layer%s, Net%s, and Solver%s interact. TODO(dox): more thorough description.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FloatBlob()
FloatBlob(int[] shape)
FloatBlob(IntBuffer shape)
FloatBlob(int num, int channels, int height, int width) \brief Deprecated; use Blob(const vector& shape).
FloatBlob(IntPointer shape)
FloatBlob(long size) Native array allocator.
FloatBlob(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
float	asum_data() \brief Compute the sum of absolute values (L1 norm) of the data.
float	asum_diff() \brief Compute the sum of absolute values (L1 norm) of the diff.
int	CanonicalAxisIndex(int axis_index) \brief Returns the 'canonical' version of a (usually) user-specified axis, allowing for negative indexing (e.g., -1 for the last axis).
int	channels() \brief Deprecated legacy shape accessor channels: use shape(1) instead.
void	CopyFrom(FloatBlob source)
void	CopyFrom(FloatBlob source, boolean copy_diff, boolean reshape) \brief Copy from a source Blob.
int	count()
int	count(int start_axis) \brief Compute the volume of a slice spanning from a particular first axis to the final axis.
int	count(int start_axis, int end_axis) \brief Compute the volume of a slice; i.e., the product of dimensions among a range of axes.
FloatPointer	cpu_data()
FloatPointer	cpu_diff()
float	data_at(int[] index)
float	data_at(IntBuffer index)
float	data_at(int n, int c, int h, int w)
float	data_at(IntPointer index)
SyncedMemory	data()
float	diff_at(int[] index)
float	diff_at(IntBuffer index)
float	diff_at(int n, int c, int h, int w)
float	diff_at(IntPointer index)
SyncedMemory	diff()
void	FromProto(BlobProto proto)
void	FromProto(BlobProto proto, boolean reshape)
FloatBlob	getPointer(long i)
FloatPointer	gpu_data()
FloatPointer	gpu_diff()
IntPointer	gpu_shape()
int	height() \brief Deprecated legacy shape accessor height: use shape(2) instead.
int	LegacyShape(int index)
FloatPointer	mutable_cpu_data()
FloatPointer	mutable_cpu_diff()
FloatPointer	mutable_gpu_data()
FloatPointer	mutable_gpu_diff()
int	num_axes()
int	num() \brief Deprecated legacy shape accessor num: use shape(0) instead.
int	offset(int n)
int	offset(int[] indices)
int	offset(IntBuffer indices)
int	offset(int n, int c, int h, int w)
int	offset(IntPointer indices)
FloatBlob	position(long position)
void	Reshape(BlobShape shape)
void	Reshape(int[] shape)
void	Reshape(IntBuffer shape)
void	Reshape(int num, int channels, int height, int width) \brief Deprecated; use Reshape(const vector& shape).
void	Reshape(IntPointer shape) \brief Change the dimensions of the blob, allocating new memory if necessary.
void	ReshapeLike(FloatBlob other)
void	scale_data(float scale_factor) \brief Scale the blob data by a constant factor.
void	scale_diff(float scale_factor) \brief Scale the blob diff by a constant factor.
void	set_cpu_data(float[] data)
void	set_cpu_data(FloatBuffer data)
void	set_cpu_data(FloatPointer data)
void	set_gpu_data(float[] data)
void	set_gpu_data(FloatBuffer data)
void	set_gpu_data(FloatPointer data)
BytePointer	shape_string()
IntPointer	shape()
int	shape(int index) \brief Returns the dimension of the index-th axis (or the negative index-th axis from the end, if index is negative).
boolean	ShapeEquals(BlobProto other)
void	ShareData(FloatBlob other) \brief Set the data_ shared_ptr to point to the SyncedMemory holding the data_ of Blob other -- useful in Layer%s which simply perform a copy in their Forward pass.
void	ShareDiff(FloatBlob other) \brief Set the diff_ shared_ptr to point to the SyncedMemory holding the diff_ of Blob other -- useful in Layer%s which simply perform a copy in their Forward pass.
float	sumsq_data() \brief Compute the sum of squares (L2 norm squared) of the data.
float	sumsq_diff() \brief Compute the sum of squares (L2 norm squared) of the diff.
void	ToProto(BlobProto proto)
void	ToProto(BlobProto proto, boolean write_diff)
void	Update()
int	width() \brief Deprecated legacy shape accessor width: use shape(3) instead.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FloatBlob

public FloatBlob(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

FloatBlob

public FloatBlob(long size)

Native array allocator. Access with Pointer.position(long).

FloatBlob

public FloatBlob()

FloatBlob

public FloatBlob(int num,
                 int channels,
                 int height,
                 int width)

\brief Deprecated; use Blob(const vector& shape).

FloatBlob

public FloatBlob(@StdVector
                 IntPointer shape)

FloatBlob

public FloatBlob(@StdVector
                 IntBuffer shape)

FloatBlob

public FloatBlob(@StdVector
                 int[] shape)

Method Detail

position

public FloatBlob position(long position)

Overrides:

position in class Pointer

getPointer

public FloatBlob getPointer(long i)

Overrides:

getPointer in class Pointer

Reshape

public void Reshape(int num,
                    int channels,
                    int height,
                    int width)

\brief Deprecated; use Reshape(const vector& shape).

Reshape

public void Reshape(@StdVector
                    IntPointer shape)

\brief Change the dimensions of the blob, allocating new memory if necessary. This function can be called both to create an initial allocation of memory, and to adjust the dimensions of a top blob during Layer::Reshape or Layer::Forward. When changing the size of blob, memory will only be reallocated if sufficient memory does not already exist, and excess memory will never be freed. Note that reshaping an input blob and immediately calling Net::Backward is an error; either Net::Forward or Net::Reshape need to be called to propagate the new input shape to higher layers.

Reshape

public void Reshape(@StdVector
                    IntBuffer shape)

Reshape

public void Reshape(@StdVector
                    int[] shape)

Reshape

public void Reshape(@Const @ByRef
                    BlobShape shape)

ReshapeLike

public void ReshapeLike(@Const @ByRef
                        FloatBlob other)

shape_string

@StdString
public BytePointer shape_string()

shape

@StdVector
public IntPointer shape()

shape

public int shape(int index)

\brief Returns the dimension of the index-th axis (or the negative index-th axis from the end, if index is negative).

Parameters:

index - the axis index, which may be negative as it will be "canonicalized" using CanonicalAxisIndex. Dies on out of range index.

num_axes

public int num_axes()

count

public int count()

count

public int count(int start_axis,
                 int end_axis)

\brief Compute the volume of a slice; i.e., the product of dimensions among a range of axes.

Parameters:

start_axis - The first axis to include in the slice.

end_axis - The first axis to exclude from the slice.

count

public int count(int start_axis)

\brief Compute the volume of a slice spanning from a particular first axis to the final axis.

Parameters:

start_axis - The first axis to include in the slice.

CanonicalAxisIndex

public int CanonicalAxisIndex(int axis_index)

\brief Returns the 'canonical' version of a (usually) user-specified axis, allowing for negative indexing (e.g., -1 for the last axis).

Parameters:

axis_index - the axis index. If 0 <= index < num_axes(), return index. If -num_axes <= index <= -1, return (num_axes() - (-index)), e.g., the last axis index (num_axes() - 1) if index == -1, the second to last if index == -2, etc. Dies on out of range index.

num

public int num()

\brief Deprecated legacy shape accessor num: use shape(0) instead.

channels

public int channels()

\brief Deprecated legacy shape accessor channels: use shape(1) instead.

height

public int height()

\brief Deprecated legacy shape accessor height: use shape(2) instead.

width

public int width()

\brief Deprecated legacy shape accessor width: use shape(3) instead.

LegacyShape

public int LegacyShape(int index)

offset

public int offset(int n,
                  int c,
                  int h,
                  int w)

offset

public int offset(int n)

offset

public int offset(@StdVector
                  IntPointer indices)

offset

public int offset(@StdVector
                  IntBuffer indices)

offset

public int offset(@StdVector
                  int[] indices)

CopyFrom

public void CopyFrom(@Const @ByRef
                     FloatBlob source,
                     @Cast(value="bool")
                     boolean copy_diff,
                     @Cast(value="bool")
                     boolean reshape)

\brief Copy from a source Blob.

Parameters:

source - the Blob to copy from

copy_diff - if false, copy the data; if true, copy the diff

reshape - if false, require this Blob to be pre-shaped to the shape of other (and die otherwise); if true, Reshape this Blob to other's shape if necessary

CopyFrom

public void CopyFrom(@Const @ByRef
                     FloatBlob source)

data_at

public float data_at(int n,
                     int c,
                     int h,
                     int w)

diff_at

public float diff_at(int n,
                     int c,
                     int h,
                     int w)

data_at

public float data_at(@StdVector
                     IntPointer index)

data_at

public float data_at(@StdVector
                     IntBuffer index)

data_at

public float data_at(@StdVector
                     int[] index)

diff_at

public float diff_at(@StdVector
                     IntPointer index)

diff_at

public float diff_at(@StdVector
                     IntBuffer index)

diff_at

public float diff_at(@StdVector
                     int[] index)

data

@SharedPtr
public SyncedMemory data()

diff

@SharedPtr
public SyncedMemory diff()

cpu_data

@Const
public FloatPointer cpu_data()

set_cpu_data

public void set_cpu_data(FloatPointer data)

set_cpu_data

public void set_cpu_data(FloatBuffer data)

set_cpu_data

public void set_cpu_data(float[] data)

gpu_shape

@Const
public IntPointer gpu_shape()

gpu_data

@Const
public FloatPointer gpu_data()

set_gpu_data

public void set_gpu_data(FloatPointer data)

set_gpu_data

public void set_gpu_data(FloatBuffer data)

set_gpu_data

public void set_gpu_data(float[] data)

cpu_diff

@Const
public FloatPointer cpu_diff()

gpu_diff

@Const
public FloatPointer gpu_diff()

mutable_cpu_data

public FloatPointer mutable_cpu_data()

mutable_gpu_data

public FloatPointer mutable_gpu_data()

mutable_cpu_diff

public FloatPointer mutable_cpu_diff()

mutable_gpu_diff

public FloatPointer mutable_gpu_diff()

Update

public void Update()

FromProto

public void FromProto(@Const @ByRef
                      BlobProto proto,
                      @Cast(value="bool")
                      boolean reshape)

FromProto

public void FromProto(@Const @ByRef
                      BlobProto proto)

ToProto

public void ToProto(BlobProto proto,
                    @Cast(value="bool")
                    boolean write_diff)

ToProto

public void ToProto(BlobProto proto)

asum_data

public float asum_data()

\brief Compute the sum of absolute values (L1 norm) of the data.

asum_diff

public float asum_diff()

\brief Compute the sum of absolute values (L1 norm) of the diff.

sumsq_data

public float sumsq_data()

\brief Compute the sum of squares (L2 norm squared) of the data.

sumsq_diff

public float sumsq_diff()

\brief Compute the sum of squares (L2 norm squared) of the diff.

scale_data

public void scale_data(float scale_factor)

\brief Scale the blob data by a constant factor.

scale_diff

public void scale_diff(float scale_factor)

\brief Scale the blob diff by a constant factor.

ShareData

public void ShareData(@Const @ByRef
                      FloatBlob other)

\brief Set the data_ shared_ptr to point to the SyncedMemory holding the data_ of Blob other -- useful in Layer%s which simply perform a copy in their Forward pass. This deallocates the SyncedMemory holding this Blob's data_, as shared_ptr calls its destructor when reset with the "=" operator.

ShareDiff

public void ShareDiff(@Const @ByRef
                      FloatBlob other)

\brief Set the diff_ shared_ptr to point to the SyncedMemory holding the diff_ of Blob other -- useful in Layer%s which simply perform a copy in their Forward pass. This deallocates the SyncedMemory holding this Blob's diff_, as shared_ptr calls its destructor when reset with the "=" operator.

ShapeEquals

@Cast(value="bool")
public boolean ShapeEquals(@Const @ByRef
                                               BlobProto other)