---
name: "mlpack_util"
section: "3"
platform: "linux"
package: "mlpack-doc"
version: "1.0.10-1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/mlpack_util"
---

# mlpack\_util(3)

## NAME

mlpack::util -

## SYNOPSIS

### Classes

class **CLIDeleter**\
 *Extremely simple class whose only job is to delete the existing* **CLI** *object at the end of execution.*  class **NullOutStream**\
 *Used for* **Log::Debug** *when not compiled with debugging symbols.*  class **Option**\
 *A static object whose constructor registers a parameter with the* **CLI** *class.*  class **PrefixedOutStream**\
 *Allows us to output to an ostream with a prefix at the beginning of each line, in the same way we would output to cout or cerr.*  class **ProgramDoc**\
 *A static object whose constructor registers program documentation with the* **CLI** *class.*  class **SaveRestoreUtility**\

### Functions

std::string **GetVersion** ()\
 *This will return either 'mlpack x.y.z' or 'mlpack trunk-rXXXXX' depending on whether or not this is a stable version of mlpack or an svn revision.*  std::string **Indent** (std::string input, const size\_t howManyTabs=1)\
 *A utility function that replaces all all newlines with a number of spaces depending on the indentation level.*

### Variables

static **CLIDeleter** **cliDeleter**\
 *Declare the deleter.*

## Function Documentation

### std::string mlpack::util::GetVersion ()

This will return either 'mlpack x.y.z' or 'mlpack trunk-rXXXXX' depending on whether or not this is a stable version of mlpack or an svn revision.

### std::string mlpack::util::Indent (std::stringinput, const size\_thowManyTabs = `1`)

A utility function that replaces all all newlines with a number of spaces depending on the indentation level.

Referenced by mlpack::kernel::PSpectrumStringKernel::ToString().

## Variable Documentation

### CLIDeleter mlpack::util::cliDeleter` [static]`

Declare the deleter.

Definition at line 43 of file cli\_deleter.hpp.

## Author

Generated automatically by Doxygen for MLPACK from the source code.