OpenMS
UnnormalizedComparator Class Reference

Exception thrown if clustering is attempted without a normalized compare functor. More...

#include <OpenMS/COMPARISON/CLUSTERING/ClusterHierarchical.h>

Inheritance diagram for UnnormalizedComparator:
[legend]
Collaboration diagram for UnnormalizedComparator:
[legend]

Public Member Functions

 UnnormalizedComparator (const char *file, int line, const char *function, const char *message="Clustering with unnormalized similarity measurement requested, normalized is mandatory") throw ()
 
 ~UnnormalizedComparator () override throw ()
 
- Public Member Functions inherited from BaseException
 BaseException () noexcept
 Default constructor. More...
 
 BaseException (const char *file, int line, const char *function) noexcept
 Constructor. More...
 
 BaseException (const char *file, int line, const char *function, const std::string &name, const std::string &message) noexcept
 Constructor. More...
 
 BaseException (const BaseException &exception) noexcept
 Copy constructor. More...
 
 ~BaseException () noexcept override
 Destructor. More...
 
const char * getName () const noexcept
 Returns the name of the exception. More...
 
int getLine () const noexcept
 Returns the line number where it occurred. More...
 
const char * getFile () const noexcept
 Returns the file where it occurred. More...
 
const char * getFunction () const noexcept
 Returns the function where it occurred. More...
 
const char * getMessage () const noexcept
 Returns the message. More...
 

Additional Inherited Members

- Protected Attributes inherited from BaseException
const char * file_
 The source file the exception was thrown in. More...
 
int line_
 The line number the exception was thrown in. More...
 
const char * function_
 The source file the exception was thrown in. More...
 
std::string name_
 The name of the exception. More...
 

Detailed Description

Exception thrown if clustering is attempted without a normalized compare functor.

due to similarity - distance conversions that are mandatory in some context, compare functors must return values normalized in the range [0,1] to ensure a clean conversion

Constructor & Destructor Documentation

◆ UnnormalizedComparator()

UnnormalizedComparator ( const char *  file,
int  line,
const char *  function,
const char *  message = "Clustering with unnormalized similarity measurement requested, normalized is mandatory" 
)
throw (
)

◆ ~UnnormalizedComparator()

~UnnormalizedComparator ( )
throw (
)
override