error.h File Reference

This file contains the library error codes. More...

#include <starneig/configuration.h>

Go to the source code of this file.

Macros
#define	STARNEIG_SUCCESS   0
	The interface function was executed successfully.
#define	STARNEIG_GENERIC_ERROR   1
	The interface function encountered a generic error.
#define	STARNEIG_NOT_INITIALIZED   2
	The library was not initialized when the interface function was called.
#define	STARNEIG_INVALID_CONFIGURATION   3
	The interface function encountered an invalid configuration argument.
#define	STARNEIG_INVALID_ARGUMENTS   4
	The interface function encountered an invalid argument.
#define	STARNEIG_INVALID_DISTR_MATRIX   5
	One or more of the involved distributed matrices have an invalid distribution, invalid dimensions and/or an invalid distributed block size.
#define	STARNEIG_DID_NOT_CONVERGE   6
	The interface function encountered a situation where the QR/QZ algorithm did not converge. The matrix (pencil) may be partially in Schur form.
#define	STARNEIG_PARTIAL_REORDERING   7
	The interface function failed to reorder the (generalized) Schur form. The (generalized) Schur form may be partially reordered.
#define	STARNEIG_CLOSE_EIGENVALUES   8
	The interface function encountered a situation where two selected eigenvalues were close to each other.

Typedefs
typedef int	starneig_error_t
	Interface function return value data type.

Detailed Description

This file contains the library error codes.

Author

Mirko Myllykoski (mirko.nosp@m.m@cs.nosp@m..umu..nosp@m.se), Umeå University

LICENSE

Copyright (c) 2019, Umeå Universitet

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.