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

# unmap.hpp(3)

## NAME

src/mlpack/methods/neighbor\_search/unmap.hpp -

## SYNOPSIS

### Namespaces

 **mlpack**\
 *Linear algebra utility functions, generally performed on matrices or vectors.*   **mlpack::neighbor**\
 *Neighbor-search routines.*

### Functions

void **mlpack::neighbor::Unmap** (const arma::Mat\< size\_t \> &neighbors, const arma::mat &distances, const std::vector\< size\_t \> &referenceMap, const std::vector\< size\_t \> &queryMap, arma::Mat\< size\_t \> &neighborsOut, arma::mat &distancesOut, const bool squareRoot=false)\
 *Assuming that the datasets have been mapped using the referenceMap and the queryMap (such as during kd-tree construction), unmap the columns of the distances and neighbors matrices into neighborsOut and distancesOut, and also unmap the entries in each row of neighbors.*  void **mlpack::neighbor::Unmap** (const arma::Mat\< size\_t \> &neighbors, const arma::mat &distances, const std::vector\< size\_t \> &referenceMap, arma::Mat\< size\_t \> &neighborsOut, arma::mat &distancesOut, const bool squareRoot=false)\
 *Assuming that the datasets have been mapped using referenceMap (such as during kd-tree construction), unmap the columns of the distances and neighbors matrices into neighborsOut and distancesOut, and also unmap the entries in each row of neighbors.*

## Detailed Description

**Author:**

Ryan Curtin

Convenience methods to unmap results.

This file is part of MLPACK 1.0.10.

MLPACK is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

MLPACK is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details (LICENSE.txt).

You should have received a copy of the GNU General Public License along with MLPACK. If not, see http://www.gnu.org/licenses/.

Definition in file **unmap.hpp**.

## Author

Generated automatically by Doxygen for MLPACK from the source code.