Skip to content

Commit

Permalink
add to changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
balos1 committed Dec 12, 2023
1 parent 05fc80f commit b05cb89
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 26 deletions.
13 changes: 11 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ sundials_band.h
**Breaking change**
The following functions have had their signature updated to ensure they can leverage
the new SUNDIALS error handling capabilties.
the new SUNDIALS error handling capabilties.
```c
// From sundials_futils.h
Expand Down Expand Up @@ -130,7 +130,16 @@ accordingly.

**Breaking change**
Functions, types and header files that were previously deprecated have been
removed.
removed. In addittion the following names/symbols were replaced by ``SUN_ERR_*``
codes:

```
SUNMAT_SUCCESS --> SUN_SUCCESS
SUNMAT_ILL_INPUT --> SUN_ERR_ARG_*
SUNMAT_MEM_FAIL --> SUN_ERR_MEM_FAIL
SUNMAT_OPERATION_FAIL --> SUN_ERR_OP_FAIL
SUNMAT_MATVEC_SETUP_REQUIRED --> SUN_ERR_OP_FAIL
```

**Breaking change**
Users now need to link to `sundials_core` in addition to the libraries already linked to.
Expand Down
24 changes: 0 additions & 24 deletions doc/shared/sunmatrix/SUNMatrix_Operations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,27 +170,3 @@ below.
.. code-block:: c
retval = SUNMatMatvec(A, x, y);
.. _SUNMatrix.Ops.errorCodes:
SUNMatrix return codes
----------------------
The functions provided to SUNMatrix modules within the SUNDIALS-provided
SUNMatrix implementations utilize a common set of return codes, listed below.
These adhere to a common pattern: 0 indicates success, a negative value
indicates a failure. Aside from this pattern, the actual values of each error
code are primarily to provide additional information to the user in case of a
SUNMatrix failure.
* ``SUN_SUCCESS`` (0) -- successful call
* ``SUN_ERR_ARG_INCOMPATIBLE`` (-1) -- an illegal input has been provided to the function
* ``SUN_ERR_MEM_FAIL`` (-2) -- failed memory access or allocation
* ``SUN_ERR_OP_FAIL`` (-3) -- a SUNMatrix operation returned nonzero
* ``SUN_ERR_OP_FAIL`` (-4) -- the :c:func:`SUNMatMatvecSetup` routine needs to be
called prior to calling :c:func:`SUNMatMatvec`

0 comments on commit b05cb89

Please sign in to comment.