java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
    - - org.platanios.tensorflow.proto.GradientDef.Builder

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, GradientDefOrBuilder

Enclosing class:: GradientDef

public static final class GradientDef.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
implements GradientDefOrBuilder

 GradientDef defines the gradient function of a function defined in
 a function library.
 A gradient function g (specified by gradient_func) for a function f
 (specified by function_name) must follow the following:
 The function 'f' must be a numerical function which takes N inputs
 and produces M outputs. Its gradient function 'g', which is a
 function taking N + M inputs and produces N outputs.
 I.e. if we have
    (y1, y2, ..., y_M) = f(x1, x2, ..., x_N),
 then, g is
    (dL/dx1, dL/dx2, ..., dL/dx_N) = g(x1, x2, ..., x_N,
                                      dL/dy1, dL/dy2, ..., dL/dy_M),
 where L is a scalar-value function of (x1, x2, ..., xN) (e.g., the
 loss function). dL/dx_i is the partial derivative of L with respect
 to x_i.

Protobuf type org.platanios.tensorflow.proto.GradientDef

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GradientDef.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`GradientDef`	`build()`
`GradientDef`	`buildPartial()`
`GradientDef.Builder`	`clear()`
`GradientDef.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`GradientDef.Builder`	`clearFunctionName()`	The function name.
`GradientDef.Builder`	`clearGradientFunc()`	The gradient function's name.
`GradientDef.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`GradientDef.Builder`	`clone()`
`GradientDef`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getFunctionName()`	The function name.
`com.google.protobuf.ByteString`	`getFunctionNameBytes()`	The function name.
`java.lang.String`	`getGradientFunc()`	The gradient function's name.
`com.google.protobuf.ByteString`	`getGradientFuncBytes()`	The gradient function's name.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`GradientDef.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`GradientDef.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`GradientDef.Builder`	`mergeFrom(GradientDef other)`
`GradientDef.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`GradientDef.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`GradientDef.Builder`	`setFunctionName(java.lang.String value)`	The function name.
`GradientDef.Builder`	`setFunctionNameBytes(com.google.protobuf.ByteString value)`	The function name.
`GradientDef.Builder`	`setGradientFunc(java.lang.String value)`	The gradient function's name.
`GradientDef.Builder`	`setGradientFuncBytes(com.google.protobuf.ByteString value)`	The gradient function's name.
`GradientDef.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`GradientDef.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - clear
```
public GradientDef.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - getDefaultInstanceForType
```
public GradientDef getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public GradientDef build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public GradientDef buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public GradientDef.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - setField
```
public GradientDef.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    java.lang.Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - clearField
```
public GradientDef.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - clearOneof
```
public GradientDef.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - setRepeatedField
```
public GradientDef.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            java.lang.Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - addRepeatedField
```
public GradientDef.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            java.lang.Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - mergeFrom
```
public GradientDef.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GradientDef.Builder>
  - mergeFrom
```
public GradientDef.Builder mergeFrom(GradientDef other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - mergeFrom
```
public GradientDef.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GradientDef.Builder>
    
    Throws:
    
    java.io.IOException
  - getFunctionName
```
public java.lang.String getFunctionName()
```
    The function name.
    string function_name = 1;
    Specified by:
    
    getFunctionName in interface GradientDefOrBuilder
    
    Returns:
    
    The functionName.
  - getFunctionNameBytes
```
public com.google.protobuf.ByteString getFunctionNameBytes()
```
    The function name.
    string function_name = 1;
    Specified by:
    
    getFunctionNameBytes in interface GradientDefOrBuilder
    
    Returns:
    
    The bytes for functionName.
  - setFunctionName
```
public GradientDef.Builder setFunctionName(java.lang.String value)
```
    The function name.
    string function_name = 1;
    Parameters:
    
    value - The functionName to set.
    
    Returns:
    
    This builder for chaining.
  - clearFunctionName
```
public GradientDef.Builder clearFunctionName()
```
    The function name.
    string function_name = 1;
    Returns:
    
    This builder for chaining.
  - setFunctionNameBytes
```
public GradientDef.Builder setFunctionNameBytes(com.google.protobuf.ByteString value)
```
    The function name.
    string function_name = 1;
    Parameters:
    
    value - The bytes for functionName to set.
    
    Returns:
    
    This builder for chaining.
  - getGradientFunc
```
public java.lang.String getGradientFunc()
```
    The gradient function's name.
    string gradient_func = 2;
    Specified by:
    
    getGradientFunc in interface GradientDefOrBuilder
    
    Returns:
    
    The gradientFunc.
  - getGradientFuncBytes
```
public com.google.protobuf.ByteString getGradientFuncBytes()
```
    The gradient function's name.
    string gradient_func = 2;
    Specified by:
    
    getGradientFuncBytes in interface GradientDefOrBuilder
    
    Returns:
    
    The bytes for gradientFunc.
  - setGradientFunc
```
public GradientDef.Builder setGradientFunc(java.lang.String value)
```
    The gradient function's name.
    string gradient_func = 2;
    Parameters:
    
    value - The gradientFunc to set.
    
    Returns:
    
    This builder for chaining.
  - clearGradientFunc
```
public GradientDef.Builder clearGradientFunc()
```
    The gradient function's name.
    string gradient_func = 2;
    Returns:
    
    This builder for chaining.
  - setGradientFuncBytes
```
public GradientDef.Builder setGradientFuncBytes(com.google.protobuf.ByteString value)
```
    The gradient function's name.
    string gradient_func = 2;
    Parameters:
    
    value - The bytes for gradientFunc to set.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final GradientDef.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>
  - mergeUnknownFields
```
public final GradientDef.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GradientDef.Builder>

Class GradientDef.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getFunctionName

getFunctionNameBytes

setFunctionName

clearFunctionName

setFunctionNameBytes

getGradientFunc

getGradientFuncBytes

setGradientFunc

clearGradientFunc

setGradientFuncBytes

setUnknownFields

mergeUnknownFields