Tapkee
|
Namespaces | |
keywords | |
tapkee_internal | |
Classes | |
struct | dummy_features_callback |
struct | dummy_kernel_callback |
struct | dummy_distance_callback |
struct | eigen_features_callback |
struct | eigen_kernel_callback |
struct | eigen_distance_callback |
struct | precomputed_kernel_callback |
struct | precomputed_distance_callback |
struct | initialize |
struct | TapkeeOutput |
class | wrong_parameter_error |
class | wrong_parameter_type_error |
class | missed_parameter_error |
class | unsupported_method_error |
class | not_enough_memory_error |
class | multiple_parameter_error |
class | cancelled_exception |
class | eigendecomposition_error |
struct | Message |
class | Parameter |
class | CheckedParameter |
class | ParametersSet |
struct | ProjectionImplementation |
struct | ProjectingFunction |
struct | MatrixProjectionImplementation |
struct | BatchCallbackTraits |
class | is_dummy |
struct | MethodTraits |
class | LoggerImplementation |
class | DefaultLoggerImplementation |
class | LoggingSingleton |
Typedefs | |
typedef double | ScalarType |
typedef int | IndexType |
typedef Eigen::Matrix < tapkee::ScalarType, Eigen::Dynamic, 1 > | DenseVector |
typedef Eigen::Matrix < tapkee::ScalarType, Eigen::Dynamic, Eigen::Dynamic > | DenseMatrix |
typedef tapkee::DenseMatrix | DenseSymmetricMatrix |
typedef Eigen::DiagonalMatrix < tapkee::ScalarType, Eigen::Dynamic > | DenseDiagonalMatrix |
typedef Eigen::SparseMatrix < tapkee::ScalarType > | SparseWeightMatrix |
typedef Eigen::SparseMatrix < tapkee::ScalarType > | SparseMatrix |
typedef Eigen::SelfAdjointEigenSolver < tapkee::DenseMatrix > | DenseSelfAdjointEigenSolver |
typedef Eigen::LDLT < tapkee::DenseMatrix > | DenseSolver |
typedef Eigen::SimplicialLDLT < tapkee::SparseWeightMatrix > | SparseSolver |
Functions | |
IndexType | uniform_random_index () |
IndexType | uniform_random_index_bounded (IndexType upper) |
ScalarType | uniform_random () |
ScalarType | gaussian_random () |
template<class RAI > | |
void | random_shuffle (RAI first, RAI last) |
template<class RandomAccessIterator , class KernelCallback , class DistanceCallback , class FeaturesCallback > | |
TapkeeOutput | embed (RandomAccessIterator begin, RandomAccessIterator end, KernelCallback kernel_callback, DistanceCallback distance_callback, FeaturesCallback features_callback, ParametersSet parameters) |
std::string | get_method_name (DimensionReductionMethod m) |
std::string | get_neighbors_method_name (NeighborsMethod m) |
std::string | get_eigen_method_name (EigenMethod m) |
Variables | |
static NeighborsMethod | default_neighbors_method = CoverTree |
static EigenMethod | default_eigen_method = Arpack |
typedef Eigen::DiagonalMatrix<tapkee::ScalarType,Eigen::Dynamic> DenseDiagonalMatrix |
typedef Eigen::Matrix<tapkee::ScalarType,Eigen::Dynamic,Eigen::Dynamic> DenseMatrix |
typedef Eigen::SelfAdjointEigenSolver<tapkee::DenseMatrix> DenseSelfAdjointEigenSolver |
typedef Eigen::LDLT<tapkee::DenseMatrix> DenseSolver |
typedef Eigen::Matrix<tapkee::ScalarType,Eigen::Dynamic,1> DenseVector |
typedef int IndexType |
typedef double ScalarType |
typedef Eigen::SparseMatrix<tapkee::ScalarType> SparseMatrix |
typedef Eigen::SimplicialLDLT<tapkee::SparseWeightMatrix> SparseSolver |
typedef Eigen::SparseMatrix<tapkee::ScalarType> SparseWeightMatrix |
Dimension reduction methods.
Definition at line 12 of file defines/methods.hpp.
enum EigenMethod |
Eigendecomposition methods.
Definition at line 119 of file defines/methods.hpp.
enum NeighborsMethod |
Neighbors computation methods.
Definition at line 99 of file defines/methods.hpp.
TapkeeOutput tapkee::embed | ( | RandomAccessIterator | begin, |
RandomAccessIterator | end, | ||
KernelCallback | kernel_callback, | ||
DistanceCallback | distance_callback, | ||
FeaturesCallback | features_callback, | ||
ParametersSet | parameters | ||
) |
Constructs a dense embedding with specified dimensionality using provided data represented by random access iterators and provided callbacks. Returns ReturnType that is essentially a pair of DenseMatrix (embedding of provided data) and a ProjectingFunction with corresponding ProjectionImplementation used to project data out of the sample.
RandomAccessIterator | random access iterator with no specific capabilities that points to some RandomAccessIterator::value_type (the simplest case is RandomAccessIterator::value_type being int). |
KernelCallback | a callback that defines |
DistanceCallback | a callback that defines ScalarType distance(const RandomAccessIterator::value_type&, const RandomAccessIterator::value_type&)
|
FeaturesCallback | a callback that defines |
Parameters required by the chosen algorithm are obtained from the parameter map. It gracefully fails during runtime and throws an exception if some of required parameters are not specified or have improper values.
begin | begin iterator of data |
end | end iterator of data |
kernel_callback | the kernel callback implementing |
distance_callback | the distance callback implementing ScalarType distance(const RandomAccessIterator::value_type&, const RandomAccessIterator::value_type&)
|
feature_vector_callback | the feature vector callback implementing |
parameters | a set of parameters formed with keywords expression. |
tapkee::wrong_parameter_error | if wrong parameter value is passed |
tapkee::missed_parameter_error | if some required parameter is missed |
tapkee::multiple_parameter_error | if some parameter is provided more than once |
tapkee::unsupported_method_error | if some method or combination of methods is unsupported |
tapkee::not_enough_memory_error | if there is not enough memory to perform the computations |
tapkee::cancelled_exception | if computations were cancelled due to cancel_function returned true |
tapkee::eigendecomposition_error | if eigendecomposition has failed |
ScalarType tapkee::gaussian_random | ( | ) |
Definition at line 39 of file random.hpp.
std::string tapkee::get_eigen_method_name | ( | EigenMethod | m | ) |
Returns the name of the provided eigen method
Definition at line 56 of file naming.hpp.
std::string tapkee::get_method_name | ( | DimensionReductionMethod | m | ) |
Returns the name of the provided method
Definition at line 13 of file naming.hpp.
std::string tapkee::get_neighbors_method_name | ( | NeighborsMethod | m | ) |
Returns the name of the provided neighbors method
Definition at line 42 of file naming.hpp.
void tapkee::random_shuffle | ( | RAI | first, |
RAI | last | ||
) |
Definition at line 58 of file random.hpp.
ScalarType tapkee::uniform_random | ( | ) |
Definition at line 30 of file random.hpp.
IndexType tapkee::uniform_random_index | ( | ) |
Definition at line 16 of file random.hpp.
IndexType tapkee::uniform_random_index_bounded | ( | IndexType | upper | ) |
Definition at line 25 of file random.hpp.
|
static |
Definition at line 135 of file defines/methods.hpp.
|
static |
Definition at line 113 of file defines/methods.hpp.