org.bytedeco.caffe

Class FloatRecurrentLayer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.caffe.FloatLayer

org.bytedeco.caffe.FloatRecurrentLayer

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

FloatLSTMLayer, FloatRNNLayer

@Name(value="caffe::RecurrentLayer<float>")
 @NoOffset
 @Properties(inherit=caffe.class)
public class FloatRecurrentLayer
extends FloatLayer

\brief An abstract class for implementing recurrent behavior inside of an unrolled network. This Layer type cannot be instantiated -- instead, you should use one of its implementations which defines the recurrent architecture, such as RNNLayer or LSTMLayer.

Nested Class Summary

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

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FloatRecurrentLayer(LayerParameter param)
FloatRecurrentLayer(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	AllowForceBackward(int bottom_index) \brief Return whether to allow force_backward for a given bottom blob index.
protected void	Backward_cpu(FloatBlobVector top, BoolVector propagate_down, FloatBlobVector bottom)
int	ExactNumTopBlobs() \brief Returns the exact number of top blobs required by the layer, or -1 if no exact number is required.
protected void	FillUnrolledNet(NetParameter net_param)
protected void	Forward_cpu(FloatBlobVector bottom, FloatBlobVector top)
protected void	Forward_gpu(FloatBlobVector bottom, FloatBlobVector top)
void	LayerSetUp(FloatBlobVector bottom, FloatBlobVector top) \brief Does layer-specific setup: your layer should implement this function as well as Reshape.
int	MaxBottomBlobs() \brief Returns the maximum number of bottom blobs required by the layer, or -1 if no maximum number is required.
int	MinBottomBlobs() \brief Returns the minimum number of bottom blobs required by the layer, or -1 if no minimum number is required.
protected void	OutputBlobNames(StringVector names)
protected void	RecurrentInputBlobNames(StringVector names)
protected void	RecurrentInputShapes(BlobShape shapes)
protected void	RecurrentOutputBlobNames(StringVector names)
void	Reset()
void	Reshape(FloatBlobVector bottom, FloatBlobVector top) \brief Adjust the shapes of top blobs and internal buffers to accommodate the shapes of the bottom blobs.
BytePointer	type() \brief Returns the layer type.

Methods inherited from class org.bytedeco.caffe.FloatLayer

AutoTopBlobs, Backward_gpu, Backward, blobs, CheckBlobCounts, EqualNumBottomTopBlobs, ExactNumBottomBlobs, Forward, layer_param, loss, MaxTopBlobs, MinTopBlobs, param_propagate_down, set_loss, set_param_propagate_down, SetUp, ToProto

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, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatRecurrentLayer

public FloatRecurrentLayer(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

FloatRecurrentLayer

public FloatRecurrentLayer(@Const @ByRef
                           LayerParameter param)

Method Detail

LayerSetUp

@Virtual
public void LayerSetUp(@Const @ByRef
                                FloatBlobVector bottom,
                                @Const @ByRef
                                FloatBlobVector top)

Description copied from class: FloatLayer

\brief Does layer-specific setup: your layer should implement this function as well as Reshape.

Overrides:

LayerSetUp in class FloatLayer

Parameters:

bottom - the preshaped input blobs, whose data fields store the input data for this layer

top - the allocated but unshaped output blobs This method should do one-time layer specific setup. This includes reading and processing relevent parameters from the layer_param_. Setting up the shapes of top blobs and internal buffers should be done in Reshape, which will be called before the forward pass to adjust the top blob sizes.

Reshape

@Virtual
public void Reshape(@Const @ByRef
                             FloatBlobVector bottom,
                             @Const @ByRef
                             FloatBlobVector top)

Description copied from class: FloatLayer

\brief Adjust the shapes of top blobs and internal buffers to accommodate the shapes of the bottom blobs.

Overrides:

Reshape in class FloatLayer

Parameters:

bottom - the input blobs, with the requested input shapes

top - the top blobs, which should be reshaped as needed This method should reshape top blobs as needed according to the shapes of the bottom (input) blobs, as well as reshaping any internal buffers and making any other necessary adjustments so that the layer can accommodate the bottom blobs.

Reset

@Virtual
public void Reset()

type

@Virtual
 @Const(value={false,false,true})
 @Cast(value="const char*")
public BytePointer type()

Description copied from class: FloatLayer

\brief Returns the layer type.

Overrides:

type in class FloatLayer

MinBottomBlobs

@Virtual
 @Const(value={false,false,true})
public int MinBottomBlobs()

Description copied from class: FloatLayer

\brief Returns the minimum number of bottom blobs required by the layer, or -1 if no minimum number is required. This method should be overridden to return a non-negative value if your layer expects some minimum number of bottom blobs.

Overrides:

MinBottomBlobs in class FloatLayer

MaxBottomBlobs

@Virtual
 @Const(value={false,false,true})
public int MaxBottomBlobs()

Description copied from class: FloatLayer

\brief Returns the maximum number of bottom blobs required by the layer, or -1 if no maximum number is required. This method should be overridden to return a non-negative value if your layer expects some maximum number of bottom blobs.

Overrides:

MaxBottomBlobs in class FloatLayer

ExactNumTopBlobs

@Virtual
 @Const(value={false,false,true})
public int ExactNumTopBlobs()

Description copied from class: FloatLayer

\brief Returns the exact number of top blobs required by the layer, or -1 if no exact number is required. This method should be overridden to return a non-negative value if your layer expects some exact number of top blobs.

Overrides:

ExactNumTopBlobs in class FloatLayer

AllowForceBackward

@Virtual
 @Cast(value="bool")
 @Const(value={false,false,true})
public boolean AllowForceBackward(@Const
                                                                                                  int bottom_index)

Description copied from class: FloatLayer

\brief Return whether to allow force_backward for a given bottom blob index. If AllowForceBackward(i) == false, we will ignore the force_backward setting and backpropagate to blob i only if it needs gradient information (as is done when force_backward == false).

Overrides:

AllowForceBackward in class FloatLayer

FillUnrolledNet

@Virtual(value=true)
 @Const(value={false,false,true})
protected void FillUnrolledNet(NetParameter net_param)

RecurrentInputBlobNames

@Virtual(value=true)
 @Const(value={false,false,true})
protected void RecurrentInputBlobNames(StringVector names)

RecurrentInputShapes

@Virtual(value=true)
 @Const(value={false,false,true})
protected void RecurrentInputShapes(@Cast(value={"caffe::BlobShape*","std::vector<caffe::BlobShape>*"}) @StdVector
                                                                                           BlobShape shapes)

RecurrentOutputBlobNames

@Virtual(value=true)
 @Const(value={false,false,true})
protected void RecurrentOutputBlobNames(StringVector names)

OutputBlobNames

@Virtual(value=true)
 @Const(value={false,false,true})
protected void OutputBlobNames(StringVector names)

Forward_cpu

@Virtual
protected void Forward_cpu(@Const @ByRef
                                    FloatBlobVector bottom,
                                    @Const @ByRef
                                    FloatBlobVector top)

Overrides:

Forward_cpu in class FloatLayer

Forward_gpu

@Virtual
protected void Forward_gpu(@Const @ByRef
                                    FloatBlobVector bottom,
                                    @Const @ByRef
                                    FloatBlobVector top)

Overrides:

Forward_gpu in class FloatLayer

Backward_cpu

@Virtual
protected void Backward_cpu(@Const @ByRef
                                     FloatBlobVector top,
                                     @Const @ByRef
                                     BoolVector propagate_down,
                                     @Const @ByRef
                                     FloatBlobVector bottom)

Overrides:

Backward_cpu in class FloatLayer