diff options
author | Anton Khirnov <anton@khirnov.net> | 2014-11-01 14:15:40 +0100 |
---|---|---|
committer | Anton Khirnov <anton@khirnov.net> | 2014-11-01 14:15:40 +0100 |
commit | 24499694116ff25a190e95533da09d0efaccffae (patch) | |
tree | 6721e5e4eaed1a66132e6a34aeb09c8e8b9f3813 | |
parent | c8441c7e80cca2b26bdd9f6b043ab9e4827b6703 (diff) |
Add more documentation.
-rw-r--r-- | brill_data.h | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/brill_data.h b/brill_data.h index 125970b..b8b63e8 100644 --- a/brill_data.h +++ b/brill_data.h @@ -121,8 +121,20 @@ typedef struct BDContext { ptrdiff_t stride; } BDContext; +/** + * Allocate and initialize the solver. + */ BDContext *bd_context_alloc(void); +/** + * Free the solver and everything associated with it. + */ void bd_context_free(BDContext **bd); +/** + * Solve the equation for the conformal factor ψ and export the expansion coefficients in the + * context. + * + * @return >= 0 on success, a negative error code on failure + */ int bd_solve(BDContext *bd); |