Skip to content

Commit

Permalink
Update the docsting of core functions
Browse files Browse the repository at this point in the history
  • Loading branch information
amontoison committed Aug 25, 2024
1 parent 0febf3a commit 410d6bc
Show file tree
Hide file tree
Showing 2 changed files with 575 additions and 1,207 deletions.
6 changes: 2 additions & 4 deletions docs/src/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@ CUTEst in Fortran defines functions called with `cutest_u*` or `cutest_c*`,
for the unconstrained and constrained cases, respectively.
For each of those, we dropped the `cutest_`, so the functions `cutest_ufn` and
`cutest_cfn` are available as `ufn` and `cfn`.
To use then you have to convert the types using `Cint` and `Cdouble`, and
pass arrays because of the underlying pointers in Fortran.
In practice, there isn't much improvement in calling these or `ccall`s, except
for the use of the internal `cutest_lib_double`.
It allows to have a unified interface for the routines in single, double and quadruple
precision.

**Only use these functions if you really know what you're doing.**

Expand Down
Loading

0 comments on commit 410d6bc

Please sign in to comment.