PythonVariables (deeplearning4j 1.0.0-beta7 API)

java.lang.Object
- org.datavec.python.PythonVariables

All Implemented Interfaces:

Serializable
```
public class PythonVariables
extends Object
implements Serializable
```
Holds python variable names, types and values. Also handles mapping from java types to python types.

Author:

Fariz Rahman

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PythonVariables()

Constructors
Constructor and Description
`PythonVariables()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(String name, PythonType type)`
`void`	`add(String name, PythonType type, Object value)`
`void`	`addBool(String name)` Add a null variable to the set of variables to describe the type but no value
`void`	`addBool(String name, boolean value)` Add a boolean variable to the set of variables
`void`	`addBytes(String name)`
`void`	`addBytes(String name, org.bytedeco.javacpp.BytePointer value)`
`void`	`addDict(String name)` Add a null variable to the set of variables to describe the type but no value
`void`	`addDict(String name, Map value)` Add a null variable to the set of variables to describe the type but no value
`void`	`addFloat(String name)` Add a null variable to the set of variables to describe the type but no value
`void`	`addFloat(String name, double value)` Add a double variable to the set of variables
`void`	`addFloat(String name, float value)` Add a float variable to the set of variables
`void`	`addInt(String name)` Add a null variable to the set of variables to describe the type but no value
`void`	`addInt(String name, int value)` Add an int variable to the set of variables
`void`	`addInt(String name, long value)` Add a long variable to the set of variables
`void`	`addList(String name)` Add a null variable to the set of variables to describe the type but no value
`void`	`addList(String name, Object[] value)` Add a null variable to the set of variables to describe the type but no value
`void`	`addNDArray(String name)` Add a null variable to the set of variables to describe the type but no value
`void`	`addNDArray(String name, INDArray value)` Add a null variable to the set of variables to describe the type but no value
`void`	`addNDArray(String name, NumpyArray value)` Add a null variable to the set of variables to describe the type but no value
`void`	`addStr(String name)` Add a null variable to the set of variables to describe the type but no value
`void`	`addStr(String name, String value)` Add a string variable to the set of variables
`PythonVariables`	`copySchema()` Returns a copy of the variable schema in this array without the values
`static PythonVariables`	`fromJSON(org.json.JSONArray jsonArray)` Get the python variable state relative to the input json array
`boolean`	`getBooleanValue(String name)` Returns a boolean variable with the given name.
`org.bytedeco.javacpp.BytePointer`	`getBytesValue(String name)`
`Map<?,?>`	`getDictValue(String name)`
`Double`	`getFloatValue(String name)`
`Long`	`getIntValue(String name)`
`List`	`getListValue(String name)`
`INDArray`	`getNDArrayValue(String name)`
`String`	`getStrValue(String name)` /**
`PythonType`	`getType(String name)` Returns the type for the given variable name
`Object`	`getValue(String name)` Do a general object lookup.
`String[]`	`getVariables()` Get all the variables present as a string array
`boolean`	`isEmpty()`
`static PythonVariables`	`schemaFromMap(Map<String,String> inputTypes)` Create a schema from a map.
`void`	`setValue(String name, Object value)`
`org.json.JSONArray`	`toJSON()` This variables set as its json representation (an array of json objects)

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

- Constructor Detail
  - PythonVariables
```
public PythonVariables()
```
- Method Detail
  - copySchema
```
public PythonVariables copySchema()
```
    Returns a copy of the variable schema in this array without the values
    
    Returns:
    
    an empty variables clone with no values
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    
    true if there are no variables.
  - add
```
public void add(String name,
                PythonType type)
```
    Parameters:
    
    name - Name of the variable
    
    type - Type of the variable
  - add
```
public void add(String name,
                PythonType type,
                Object value)
         throws PythonException
```
    Parameters:
    
    name - name of the variable
    
    type - type of the variable
    
    value - value of the variable (must be instance of expected type)
    
    Throws:
    
    PythonException
  - addDict
```
public void addDict(String name)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
  - addBool
```
public void addBool(String name)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
  - addStr
```
public void addStr(String name)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
  - addInt
```
public void addInt(String name)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
  - addFloat
```
public void addFloat(String name)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
  - addNDArray
```
public void addNDArray(String name)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
  - addList
```
public void addList(String name)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
  - addBool
```
public void addBool(String name,
                    boolean value)
```
    Add a boolean variable to the set of variables
    
    Parameters:
    
    name - the field to add
    
    value - the value to add
  - addStr
```
public void addStr(String name,
                   String value)
```
    Add a string variable to the set of variables
    
    Parameters:
    
    name - the field to add
    
    value - the value to add
  - addInt
```
public void addInt(String name,
                   int value)
```
    Add an int variable to the set of variables
    
    Parameters:
    
    name - the field to add
    
    value - the value to add
  - addInt
```
public void addInt(String name,
                   long value)
```
    Add a long variable to the set of variables
    
    Parameters:
    
    name - the field to add
    
    value - the value to add
  - addFloat
```
public void addFloat(String name,
                     double value)
```
    Add a double variable to the set of variables
    
    Parameters:
    
    name - the field to add
    
    value - the value to add
  - addFloat
```
public void addFloat(String name,
                     float value)
```
    Add a float variable to the set of variables
    
    Parameters:
    
    name - the field to add
    
    value - the value to add
  - addNDArray
```
public void addNDArray(String name,
                       NumpyArray value)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
    
    value - the value to add
  - addNDArray
```
public void addNDArray(String name,
                       INDArray value)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
    
    value - the value to add
  - addList
```
public void addList(String name,
                    Object[] value)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
    
    value - the value to add
  - addDict
```
public void addDict(String name,
                    Map value)
```
    Add a null variable to the set of variables to describe the type but no value
    
    Parameters:
    
    name - the field to add
    
    value - the value to add
  - addBytes
```
public void addBytes(String name)
```
  - addBytes
```
public void addBytes(String name,
                     org.bytedeco.javacpp.BytePointer value)
```
  - setValue
```
public void setValue(String name,
                     Object value)
              throws PythonException
```
    Parameters:
    
    name - name of the variable
    
    value - new value for the variable
    
    Throws:
    
    PythonException
  - getValue
```
public Object getValue(String name)
```
    Do a general object lookup. The look up will happen relative to the PythonType of variable is described in the
    
    Parameters:
    
    name - the name of the variable to get
    
    Returns:
    
    teh value for the variable with the given name
  - getBooleanValue
```
public boolean getBooleanValue(String name)
```
    Returns a boolean variable with the given name.
    
    Parameters:
    
    name - the variable name to get the value for
    
    Returns:
    
    the retrieved boolean value
  - getDictValue
```
public Map<?,?> getDictValue(String name)
```
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the dictionary value
  - getStrValue
```
public String getStrValue(String name)
```
    /**
    
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the string value
  - getIntValue
```
public Long getIntValue(String name)
```
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the long value
  - getFloatValue
```
public Double getFloatValue(String name)
```
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the float value
  - getNDArrayValue
```
public INDArray getNDArrayValue(String name)
```
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the numpy array value
  - getListValue
```
public List getListValue(String name)
```
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the list value as an object array
  - getBytesValue
```
public org.bytedeco.javacpp.BytePointer getBytesValue(String name)
```
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the bytes value as a BytePointer
  - getType
```
public PythonType getType(String name)
```
    Returns the type for the given variable name
    
    Parameters:
    
    name - the name of the variable to get the type for
    
    Returns:
    
    the type for the given variable
  - getVariables
```
public String[] getVariables()
```
    Get all the variables present as a string array
    
    Returns:
    
    the variable names for this variable sset
  - toJSON
```
public org.json.JSONArray toJSON()
```
    This variables set as its json representation (an array of json objects)
    
    Returns:
    
    the json array output
  - schemaFromMap
```
public static PythonVariables schemaFromMap(Map<String,String> inputTypes)
                                     throws Exception
```
    Create a schema from a map. This is an empty PythonVariables that just contains names and types with no values
    
    Parameters:
    
    inputTypes - the input types to convert
    
    Returns:
    
    the schema from the given map
    
    Throws:
    
    Exception
  - fromJSON
```
public static PythonVariables fromJSON(org.json.JSONArray jsonArray)
```
    Get the python variable state relative to the input json array
    
    Parameters:
    
    jsonArray - the input json array
    
    Returns:
    
    the python variables based on the input json array

Class PythonVariables

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PythonVariables

Method Detail

copySchema

isEmpty

add

add

addDict

addBool

addStr

addInt

addFloat

addNDArray

addList

addBool

addStr

addInt

addInt

addFloat

addFloat

addNDArray

addNDArray

addList

addDict

addBytes

addBytes

setValue

getValue

getBooleanValue

getDictValue

getStrValue

getIntValue

getFloatValue

getNDArrayValue

getListValue

getBytesValue

getType

getVariables

toJSON

schemaFromMap

fromJSON