Skip to content

Commit

Permalink
Prepare for release v1.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
vgvassilev committed Oct 6, 2022
1 parent 6b76d45 commit ca8b09d
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 5 deletions.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0~dev
1.0
66 changes: 62 additions & 4 deletions docs/internalDocs/ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,67 @@ described first.
External Dependencies
---------------------

* Clad now works with clang-5.0 to clang-13-rc1
* Clad now works with clang-5.0 to clang-14


Forward Mode & Reverse Mode
---------------------------
*
* Add support for pushforward- and pullback-style functions which allow to
accumulate the results from the AD when required to correctly compute
derivatives when arguments are passed by reference or pointers


Forward Mode
------------
* Add support for member variables in functors
* Add basic support for virtual functions
* Add support for reference arguments
* Add basic support for AD of class types wrt scalars
* Add support for member functions, pointers, overloaded operators, pointer
arithmetic, nullptr, sizeof and pseudo objects,



Reverse Mode
------------
* Add support for `while` and `do-while` statements
* Add initial support for AD of user-defined types allowing to
differentiate scalar types wrt user-defined types


CUDA
----
* Add forward mode support for basic CUDA programs. More can be seen
[here](https://github.com/vgvassilev/clad/tree/v1.0/test/CUDA)


Error Estimation
----------------
* Developed an error estimation framework to perform AD-based error estimation.
The new facility is available via the `clad::estimate_error` interface.
See more in this [demo](https://github.com/vgvassilev/clad/tree/v1.0/demos/ErrorEstimation)

Misc
----
* Developed user documentation available at [clad.readthedocs.io](https://clad.readthedocs.io/en/latest/)
* Developed developers documentation available at [doxygen](https://clad.readthedocs.io/en/latest/internalDocs/html/index.html)
* Implement a fallback to numerical differentiation if Clad cannot differentiate
a given function. To disable this behavior, please compile your programs with
the `-DCLAD_NO_NUM_DIFF`.
* Add benchmarking infrastructure based on google benchmark
* Add integration with Enzyme via `clad::gradient<clad::opts::use_enzyme>(...)`

Fixed Bugs
----------

*
[28](https://github.com/vgvassilev/clad/issues/28)
[281](https://github.com/vgvassilev/clad/issues/281)
[353](https://github.com/vgvassilev/clad/issues/353)
[368](https://github.com/vgvassilev/clad/issues/368)
[386](https://github.com/vgvassilev/clad/issues/386)
[387](https://github.com/vgvassilev/clad/issues/387)
[393](https://github.com/vgvassilev/clad/issues/393)
[440](https://github.com/vgvassilev/clad/issues/440)


Special Kudos
Expand All @@ -43,4 +92,13 @@ listed in the form of Firstname Lastname (#contributions):

FirstName LastName (#commits)

* A B (N)
Parth Arora (65)
Vassil Vassilev (49)
Garima Singh (17)
Baidyanath Kundu (13)
Nirhar (12)
Ioana Ifrim (9)
Alexander Penev (4)
RohitRathore1 (1)
David (1)

0 comments on commit ca8b09d

Please sign in to comment.