NDPrintSettings (neureka 1.0.1 API)

java.lang.Object
- neureka.view.NDPrintSettings

```
public final class NDPrintSettings
extends java.lang.Object
```
This is simply a mutable container for configuring how Tensor instances ought to be converted to Strings.

Constructor Summary

Constructors
Constructor and Description

NDPrintSettings(java.util.function.Supplier<java.lang.Boolean> notModifiable)

Constructors
Constructor and Description
`NDPrintSettings(java.util.function.Supplier<java.lang.Boolean> notModifiable)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NDPrintSettings`	`clone()`
`int`	`getCellSize()` A cell size refers to the number of characters reserved to the `String` representation of a single element.
`boolean`	`getHasDerivatives()`
`boolean`	`getHasGradient()`
`boolean`	`getHasRecursiveGraph()`
`boolean`	`getHasShape()`
`boolean`	`getHasSlimNumbers()`
`boolean`	`getHasValue()`
`java.lang.String`	`getIndent()`
`boolean`	`getIsCellBound()`
`boolean`	`getIsLegacy()` This flag determines the usage of bracket types, where `"[1x3]:(1, 2, 3)"` would be the legacy version of `"(1x3):[1, 2, 3]"`.
`boolean`	`getIsMultiline()`
`boolean`	`getIsScientific()`
`java.lang.String`	`getPostfix()`
`java.lang.String`	`getPrefix()`
`int`	`getRowLimit()` Very large tensors with a rank larger than 1 might take a lot of vertical space when converted to a `String`.
`NDPrintSettings`	`setCellSize(int cellSize)` A cell size refers to the number of characters reserved to the `String` representation of a single element.
`NDPrintSettings`	`setHasDerivatives(boolean hasDerivatives)`
`NDPrintSettings`	`setHasGradient(boolean hasGradient)`
`NDPrintSettings`	`setHasRecursiveGraph(boolean hasRecursiveGraph)`
`NDPrintSettings`	`setHasShape(boolean hasShape)`
`NDPrintSettings`	`setHasSlimNumbers(boolean haveSlimNumbers)`
`NDPrintSettings`	`setHasValue(boolean hasValue)`
`NDPrintSettings`	`setIndent(java.lang.String indent)`
`NDPrintSettings`	`setIsCellBound(boolean isCellBound)`
`NDPrintSettings`	`setIsLegacy(boolean legacy)` This flag determines the usage of bracket types, where `"[1x3]:(1, 2, 3)"` would be the legacy version of `"(1x3):[1, 2, 3]"`.
`NDPrintSettings`	`setIsMultiline(boolean isMultiline)`
`NDPrintSettings`	`setIsScientific(boolean isScientific)`
`NDPrintSettings`	`setPostfix(java.lang.String postfix)`
`NDPrintSettings`	`setPrefix(java.lang.String prefix)`
`NDPrintSettings`	`setRowLimit(int shortage)` Very large tensors with a rank larger than 1 might take a lot of vertical space when converted to a `String`.
`NDPrintSettings`	`with(NDPrintSettings other)`
`NDPrintSettings`	`with(java.lang.String modes)`

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

- Constructor Detail
  - NDPrintSettings
```
public NDPrintSettings(java.util.function.Supplier<java.lang.Boolean> notModifiable)
```
- Method Detail
  - clone
```
public NDPrintSettings clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - with
```
public NDPrintSettings with(NDPrintSettings other)
```
  - getCellSize
```
public int getCellSize()
```
    A cell size refers to the number of characters reserved to the String representation of a single element. This property only becomes relevant when the getIsCellBound() flag is set. This will then cause the width of the cell to be always of the specified size.
    
    Returns:
    
    The width of the cell in terms of numbers of characters.
  - setCellSize
```
public NDPrintSettings setCellSize(int cellSize)
```
    A cell size refers to the number of characters reserved to the String representation of a single element. This property only becomes relevant when the getIsCellBound() flag is set. This will then cause the width of the cell to be always of the specified size.
    
    Parameters:
    
    cellSize - The width of the cell in terms of numbers of characters.
  - getRowLimit
```
public int getRowLimit()
```
    Very large tensors with a rank larger than 1 might take a lot of vertical space when converted to a String. This property is the maximum number of matrix rows printed. It determines at which point the number of rows ought to be pruned.
    
    Returns:
    
    The maximum number of rows in the String representation of the tensor.
  - setRowLimit
```
public NDPrintSettings setRowLimit(int shortage)
```
    Very large tensors with a rank larger than 1 might take a lot of vertical space when converted to a String. This property is the maximum number of matrix rows printed. It determines at which point the number of rows ought to be pruned.
    
    Parameters:
    
    shortage - The maximum number of rows in the String representation of the tensor.
  - getHasGradient
```
public boolean getHasGradient()
```
    Returns:
    
    The truth value determining if the tensor should also print its gradient.
  - setHasGradient
```
public NDPrintSettings setHasGradient(boolean hasGradient)
```
    Parameters:
    
    hasGradient - The truth value determining if the tensor should also print its gradient.
  - getIsScientific
```
public boolean getIsScientific()
```
    Returns:
    
    The truth value determining if numeric values should be formatted in scientific notation.
  - setIsScientific
```
public NDPrintSettings setIsScientific(boolean isScientific)
```
    Parameters:
    
    isScientific - The truth value determining if numeric values should be formatted in scientific notation.
  - getIsMultiline
```
public boolean getIsMultiline()
```
    Returns:
    
    The truth value determining if the tensor should be printed in one line or across multiple lines.
  - setIsMultiline
```
public NDPrintSettings setIsMultiline(boolean isMultiline)
```
    Parameters:
    
    isMultiline - The truth value determining if the tensor should be printed in one line or across multiple lines.
  - getHasSlimNumbers
```
public boolean getHasSlimNumbers()
```
    Returns:
    
    The truth value determining if numbers should be formatted more compactly (1.0 to 1).
  - setHasSlimNumbers
```
public NDPrintSettings setHasSlimNumbers(boolean haveSlimNumbers)
```
    Parameters:
    
    haveSlimNumbers - The truth value determining if numbers should be formatted more compactly (1.0 to 1).
  - getHasValue
```
public boolean getHasValue()
```
    Returns:
    
    The truth value determining if the values of the tensor should be included in the String representation.
  - setHasValue
```
public NDPrintSettings setHasValue(boolean hasValue)
```
    Parameters:
    
    hasValue - The truth value determining if the values of the tensor should be included in the String representation.
  - getHasShape
```
public boolean getHasShape()
```
    Returns:
    
    The truth value determining if the tensor should have its shape included in the String.
  - setHasShape
```
public NDPrintSettings setHasShape(boolean hasShape)
```
    Parameters:
    
    hasShape - The truth value determining if the tensor should have its shape included in the String.
  - getHasRecursiveGraph
```
public boolean getHasRecursiveGraph()
```
    Returns:
    
    The truth value determining if the String representation of the tensor should have its computation graph attached (if present).
  - setHasRecursiveGraph
```
public NDPrintSettings setHasRecursiveGraph(boolean hasRecursiveGraph)
```
    Parameters:
    
    hasRecursiveGraph - The truth value determining if the String representation of the tensor should have its computation graph attached (if present).
  - getHasDerivatives
```
public boolean getHasDerivatives()
```
  - setHasDerivatives
```
public NDPrintSettings setHasDerivatives(boolean hasDerivatives)
```
  - getIsCellBound
```
public boolean getIsCellBound()
```
  - setIsCellBound
```
public NDPrintSettings setIsCellBound(boolean isCellBound)
```
  - getPrefix
```
public java.lang.String getPrefix()
```
    Returns:
    
    The String which will be prepended at the beginning of a Tensor string representation.
  - setPrefix
```
public NDPrintSettings setPrefix(java.lang.String prefix)
```
    Parameters:
    
    prefix - The String which will be prepended at the beginning of a Tensor string representation.
  - getPostfix
```
public java.lang.String getPostfix()
```
    Returns:
    
    The String which will be appended at the end of a Tensor string representation.
  - setPostfix
```
public NDPrintSettings setPostfix(java.lang.String postfix)
```
    Parameters:
    
    postfix - The String which will be appended at the end of a Tensor string representation.
  - getIndent
```
public java.lang.String getIndent()
```
    Returns:
    
    The indent step for a single level of nesting for String representation where the getIsMultiline() is set to true.
  - setIndent
```
public NDPrintSettings setIndent(java.lang.String indent)
```
    Parameters:
    
    indent - The indent step for a single level of nesting for String representation where the getIsMultiline() is set to true.
  - getIsLegacy
```
public boolean getIsLegacy()
```
    This flag determines the usage of bracket types, where "[1x3]:(1, 2, 3)" would be the legacy version of "(1x3):[1, 2, 3]".
    
    Returns:
    
    The truth value determining the type of brackets used.
  - setIsLegacy
```
public NDPrintSettings setIsLegacy(boolean legacy)
```
    This flag determines the usage of bracket types, where "[1x3]:(1, 2, 3)" would be the legacy version of "(1x3):[1, 2, 3]".
    
    Parameters:
    
    legacy - The truth value determining the type of brackets used.
  - with
```
public NDPrintSettings with(java.lang.String modes)
```
    Parameters:
    
    modes - A String in which letters will be translated to settings.
    
    Returns:
    
    A NDPrintSettings configuration based on the provided modes.

Class NDPrintSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NDPrintSettings

Method Detail

clone

with

getCellSize

setCellSize

getRowLimit

setRowLimit

getHasGradient

setHasGradient

getIsScientific

setIsScientific

getIsMultiline

setIsMultiline

getHasSlimNumbers

setHasSlimNumbers

getHasValue

setHasValue

getHasShape

setHasShape

getHasRecursiveGraph

setHasRecursiveGraph

getHasDerivatives

setHasDerivatives

getIsCellBound

setIsCellBound

getPrefix

setPrefix

getPostfix

setPostfix

getIndent

setIndent

getIsLegacy

setIsLegacy

with