class xilinx_apps::cosinesim::Exception

Overview

Exception class for cosine similarity run-time errors More…

#include <cosinesim.hpp>

class Exception: public exception
{
public:
    // construction

    Exception(const std::string& msg);

    // methods

    virtual const char* what() const;
};

Detailed Documentation

Exception class for cosine similarity run-time errors

This exception class is derived from std::exception and provides the standard what() member function. An object of this class is constructed with an error message string, which is stored internally and retrieved with the what() member function.

Construction

Exception(const std::string& msg)

Constructs an Exception object.

Parameters:

msg	an error message string, which is copied and stored internal to the object

Methods

virtual const char* what() const

Returns the error message string passed to the constructor.

Returns:

the error message string