NAG C++ classes for Hyperspectral Imaging  0.1
Public Member Functions | Data Fields
nag::tsne_results< FPType > Struct Template Reference

A type used to hold the details of a t-SNE analysis. More...

#include <SpecImage.hpp>

Public Member Functions

 tsne_results (tsne_results &&a)
 Move constructor. More...
 
 tsne_results ()=default
 Default constructor. More...
 
tsne_resultsoperator= (tsne_results &&a)
 Move assignment operator. More...
 

Data Fields

int k
 The number of dimensions in the embedding. More...
 
size_t m
 The number of rows of the input matrix (and the number of rows of the lower dimensional embedding). This can be interpreted as the number of data points. More...
 
size_t d
 The number of columns of the input matrix; equivalent to the number of dimensions of the input data. More...
 
FPType kl_divergence
 The Kullback-Liebler divergence between the input data and the lower-dimensional embedding. More...
 
FPType theta
 The parameter theta used in t-SNE; it represents a tradeoff between speed and accuracy: 0 is accurate but slow, 1 is faster but loses accuracy. More...
 
FPType perplexity
 The perplexity used in the t-SNE algorithm. More...
 
std::unique_ptr< FPType[], cfreeembedding
 The m by k lower-dimensional matrix, stored in column-major order. More...
 
int total_iter
 The number of iterations that were performed. More...
 

Detailed Description

template<class FPType>
struct nag::tsne_results< FPType >

A type used to hold the details of a t-SNE analysis.

For more information see: nag::SpecImage::tsne.

Constructor & Destructor Documentation

template<class FPType>
nag::tsne_results< FPType >::tsne_results ( tsne_results< FPType > &&  a)
inline

Move constructor.

template<class FPType>
nag::tsne_results< FPType >::tsne_results ( )
default

Default constructor.

Member Function Documentation

template<class FPType>
tsne_results& nag::tsne_results< FPType >::operator= ( tsne_results< FPType > &&  a)
inline

Move assignment operator.

Field Documentation

template<class FPType>
size_t nag::tsne_results< FPType >::d

The number of columns of the input matrix; equivalent to the number of dimensions of the input data.

template<class FPType>
std::unique_ptr<FPType[], cfree> nag::tsne_results< FPType >::embedding

The m by k lower-dimensional matrix, stored in column-major order.

template<class FPType>
int nag::tsne_results< FPType >::k

The number of dimensions in the embedding.

template<class FPType>
FPType nag::tsne_results< FPType >::kl_divergence

The Kullback-Liebler divergence between the input data and the lower-dimensional embedding.

template<class FPType>
size_t nag::tsne_results< FPType >::m

The number of rows of the input matrix (and the number of rows of the lower dimensional embedding). This can be interpreted as the number of data points.

template<class FPType>
FPType nag::tsne_results< FPType >::perplexity

The perplexity used in the t-SNE algorithm.

template<class FPType>
FPType nag::tsne_results< FPType >::theta

The parameter theta used in t-SNE; it represents a tradeoff between speed and accuracy: 0 is accurate but slow, 1 is faster but loses accuracy.

template<class FPType>
int nag::tsne_results< FPType >::total_iter

The number of iterations that were performed.


The documentation for this struct was generated from the following file: