source: trunk/omh/deprecated/fun_deprecated.omh @ 3607

Last change on this file since 3607 was 3607, checked in by bradbell, 5 years ago

merge to branch: trunk
from repository: https://github.com/coin-or/CppAD
start hash code: f4baab0ea7c2679ba9351b0439b6efebfa77ba04
end hash code: 894d554a00ceec8a3545f05eca62708a7b5cb43d

commit 894d554a00ceec8a3545f05eca62708a7b5cb43d
Author: Brad Bell <bradbell@…>
Date: Tue Jan 20 09:06:10 2015 -0700

Fix copyright end date.


whats_new_15.omh: Add comment about date of deprecation.

commit 611e982000168db91aba22b763c14bb78d57da47
Author: Brad Bell <bradbell@…>
Date: Tue Jan 20 08:53:00 2015 -0700

Squashed commit from old/compare_op to master:


In addition, fix copyright end date for some files, and add note about
deprecated date in whats_new_15.omh.


commit 6e46df5c850ecd58d7a886db4043bc3f2d4579d1
Author: Brad Bell <bradbell@…>
Date: Tue Jan 20 08:16:57 2015 -0700


Always return f.compare_change_op_index() == 0 after f.optimize().


checkpoint.hpp: ignore comparison operators.
fun_construct.hpp: remove double initilaization of values.
compare_change.cpp: demonstrate more features of new interface.
whats_new_15.omh: prepare for merging this branch into master.
wish_list.omh: update wish list item to new compare_change interface.


commit 45315907c70e5b383d984fb9498b54a474001af0
Author: Brad Bell <bradbell@…>
Date: Tue Jan 20 05:04:37 2015 -0700


Use the new f.compare_change_count(0) option in speed tests.


commit bb6e72befd6d01f1fb62c43b9b19471ffaa7cc2c
Author: Brad Bell <bradbell@…>
Date: Tue Jan 20 04:51:16 2015 -0700


Move CompareChange? -> deprecated and plan -> compare_change.


forward0sweep.hpp: skip comparison operator when count is zero.
forward1sweep.hpp: skip comparison operator when count is zero.
compare_change.cpp: demonstrate count == 0 case.


commit 622a13c568c612d9dfe9ccd1a01f4ac5f74ba824
Author: Brad Bell <bradbell@…>
Date: Mon Jan 19 23:17:42 2015 -0700


Add example and test of new compare change user API.


ad_fun.hpp: fix f.compare_change_op_index.
compare_change.cpp: Change example to use new API.
compare_change.cpp: Move old example here (just test now).


commit ec4c1613eae8df56fbf31e7b8711ce69cc41df83
Author: Brad Bell <bradbell@…>
Date: Mon Jan 19 21:12:11 2015 -0700


Implement the compare change plan, still needs an example and test.
Also have the change from 'plan' to just plain documentation.


commit a81a46f27011bee08ba072551044dc9f4a99a906
Author: Brad Bell <bradbell@…>
Date: Mon Jan 19 17:49:05 2015 -0700


Change name of compare_change functions and partially implement this new plan.


commit 146faad48a700a56362e74f9c3a3c39144a79738
Author: Brad Bell <bradbell@…>
Date: Mon Jan 19 14:22:40 2015 -0700


Branch: compare_op
plan.omh: change name of count function.


commit 35d91d126765d1a0ab4bfe9e2b006bbf535cd648
Author: Brad Bell <bradbell@…>
Date: Mon Jan 19 13:19:07 2015 -0700


Add deprecation date for some more cases.


commit 5bb65a8c48fae4263b66fcd04520e10e66febc11
Author: Brad Bell <bradbell@…>
Date: Mon Jan 19 13:13:51 2015 -0700


Add date of deprecation for some more cases.


commit e95ee6b209601cd9a075d2e37c602e73c32fb6ab
Author: Brad Bell <bradbell@…>
Date: Mon Jan 19 12:58:44 2015 -0700


Add date of deprecation for some more cases.


commit 0ea84ccd87383edc62a6ae1711da104b12e8c444
Author: Brad Bell <bradbell@…>
Date: Mon Jan 19 12:47:01 2015 -0700


Add date of deprecation for some cases.


commit 17755e609ea8e03472b08dcc2fb5ad347eb723cb
Author: Brad Bell <bradbell@…>
Date: Mon Jan 19 08:20:45 2015 -0700


plan.omh: changs some names.


commit 29f369c06d4d0ee284c4c668d52d8461613066dc
Author: Brad Bell <bradbell@…>
Date: Fri Jan 16 06:39:45 2015 -0700


Document the plan for compare_change user API.


compare_change.omh: fix minor typo.
plan.txt: change to the omhelp file plan.omh.


commit a3a2f4dedd202a722812b6eb2714851b40726e6e
Author: Brad Bell <bradbell@…>
Date: Thu Jan 15 21:03:44 2015 -0700


new_branch.sh: remove unused variable.
push_git2svn.py: move repository from github/bradbell to coin-or/bradbell.


commit 3751a197ab2897e76616f9d9b0915148bd855356
Author: Brad Bell <bradbell@…>
Date: Thu Jan 15 20:56:17 2015 -0700


plan.txt: plan for this branches API will go here.


commit 76013ec2ad7baacdeab5e761812d542867910174
Author: Brad Bell <bradbell@…>
Date: Thu Jan 15 18:04:33 2015 -0700


Store the operator index for the first comparision change in the ADFun object.


commit 9caf25014079a60df5de17bcac76775daf8ee201
Author: Brad Bell <bradbell@…>
Date: Thu Jan 15 12:45:56 2015 -0700


Make compare_change a parameter (so will be easy to add compare_first).


commit 2246d22fe82b8909d432f82ab0d783ce3351a02f
Author: Brad Bell <bradbell@…>
Date: Thu Jan 15 09:12:40 2015 -0700


speed_branch.sh: fix directory (before cd).


commit b3910de86558a97749741bfb728e45c5a86d1c73
Author: Brad Bell <bradbell@…>
Date: Thu Jan 15 05:14:01 2015 -0700


search.sh: use git to get list of source files.
ad_fun.hpp: imporve doxygen doc for compare_change_.
ad_tape.hpp: remove RecordCompare? (no longer used).
atomic_base.hpp: minor edit to user documentation.


commit dd74f331386cadc9cc272c264296e575691aa3f8
Author: Brad Bell <bradbell@…>
Date: Thu Jan 15 04:12:34 2015 -0700


Change Leq..Op -> Le..Op and leq.._op -> le.._op.


commit ae729296323eb7f4f4a7c0e90a303a8d7f4ed42a
Author: Brad Bell <bradbell@…>
Date: Wed Jan 14 21:19:55 2015 -0700


comp_op.hpp: Add doxygen documentaiton for compare operators.
compare.hpp: avoid an extra branch.


commit b064d59a5ad01dff5c708cc8c02f628f58c863ec
Author: Brad Bell <bradbell@…>
Date: Wed Jan 14 16:11:25 2015 -0700


Remove ComOp?, replaced by specific cases Eq..Op, Ne..Op, Leq..Op, Lt..Op,
which should run faster.


forward0sweep.hpp: Remove out-dated comment about CompOp?.
forward1sweep.hpp: Remove out-dated comment about CompOp?.


commit 5bb0a70d1151e9086b88024050cea6cf11e83aa7
Author: Brad Bell <bradbell@…>
Date: Wed Jan 14 09:02:17 2015 -0700


Use Eq..Op, Ne..Op to implement == and !=.


commit 0ebeec61bc040a00c50db41ca5da31fb87194f93
Author: Brad Bell <bradbell@…>
Date: Wed Jan 14 07:19:26 2015 -0700


compare.hpp: Finish folding < <= > >= into Lt..Op and Leq..Op.


commit c949e5b72158b98cbab61c8aea98e76008e9c2f4
Author: Brad Bell <bradbell@…>
Date: Wed Jan 14 06:28:41 2015 -0700


  1. Change plan to fold all compare operations into Leq..Op and Lt..Op cases.
  2. Fix alphabetical order between Ld and Leq.


commit 6ffee88b68b682359d62bc75a8c2ba3e28d012ac
Author: Brad Bell <bradbell@…>
Date: Tue Jan 13 22:40:18 2015 -0700


Splite parameter <= variable and parameter > variable as separate compare
operators.


commit 0841014db4ead690d1c2358f5e09494030ae1e5f
Author: Brad Bell <bradbell@…>
Date: Tue Jan 13 21:12:57 2015 -0700


Attempting to recording and playback of compare operators faster:
Split variable <= variable and variable > variable out as separate cases.


compare.hpp: remove white space at end of lines.


commit cfd3afceebd4b3383b3042cbca98caf82ff77670
Author: Brad Bell <bradbell@…>
Date: Tue Jan 13 08:39:12 2015 -0700


speed_branch.sh: compare speed_cppad between two git branches.
speed_new.sh: correct list of options, remove unused variable.
wish_list.omh: correct discussion of effect of keeping compare operators.


commit 9ed03e1ee2c258ca38561ad083067e235d032e14
Author: Brad Bell <bradbell@…>
Date: Tue Jan 13 05:54:30 2015 -0700


Change test so it corresponds to optimization keeping compare operators.


commit 5c418d477d58984b094bba027ebb0794e759e557
Author: Brad Bell <bradbell@…>
Date: Tue Jan 13 05:12:50 2015 -0700


Include example and test of using CompareChange? with optimized tape.


commit c1b48edfa56ca096ce8c2db1dbadb2658cb13fe3
Author: Brad Bell <bradbell@…>
Date: Tue Jan 13 04:24:54 2015 -0700


Fix optimization so variables used in compare opertions are alwasy available.


commit 6fe607ca30db07b356fd3a9fe9779fa2dfd382d8
Author: Brad Bell <bradbell@…>
Date: Mon Jan 12 07:56:41 2015 -0700


Keep CompareChange? in optimized versions of tape and when NDEBUG is defined.

commit b4c0e51489cc0878499a331b4af4875b2781d8d8
Author: Brad Bell <bradbell@…>
Date: Sun Jan 11 17:01:59 2015 -0700

new_branch.sh: final procedure (only hand tested).

  • Property svn:keywords set to Id
File size: 5.4 KB
Line 
1$Id: fun_deprecated.omh 3607 2015-01-20 16:20:41Z bradbell $
2/* --------------------------------------------------------------------------
3CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-15 Bradley M. Bell
4
5CppAD is distributed under multiple licenses. This distribution is under
6the terms of the
7                    Eclipse Public License Version 1.0.
8
9A copy of this license is included in the COPYING file of this distribution.
10Please visit http://www.coin-or.org/CppAD/ for information on other licenses.
11-------------------------------------------------------------------------- */
12$begin FunDeprecated$$
13$spell
14        bool
15        VecAD
16        CppAD
17        const
18        Taylor
19        sizeof
20        var
21$$
22
23$section ADFun Object Deprecated Member Functions$$
24
25$head Syntax$$
26$icode%f%.Dependent(%y%)
27%$$
28$icode%o% = %f%.Order()
29%$$
30$icode%m% = %f%.Memory()
31%$$
32$icode%s% = %f%.Size()
33%$$
34$icode%t% = %f%.taylor_size()
35%$$
36$icode%u% = %f%.use_VecAD()
37%$$
38$icode%v% = %f%.size_taylor()
39%$$
40$icode%w% = %f%.capacity_taylor()
41%$$
42
43
44$head Purpose$$
45The $codei%ADFun<%Base%>%$$ functions documented here have been deprecated;
46i.e., they are no longer approved of and may be removed from some future
47version of CppAD.
48
49$head Dependent$$
50$index ADFun, Dependent$$
51$index Dependent, ADFun$$
52A recording of and AD of $icode Base$$
53$cref/operation sequence/glossary/Operation/Sequence/$$
54is started by a call of the form
55$codei%
56        Independent(%x%)
57%$$
58If there is only one such recording at the current time,
59you can use $icode%f%.Dependent(%y%)%$$ in place of
60$codei%
61        %f%.Dependent(%x%, %y%)
62%$$
63See $cref Dependent$$ for a description of this operation.
64
65$subhead Deprecated 2007-08-07$$
66This syntax was deprecated when CppAD was extended to allow
67for more than one $codei%AD<%Base%>%$$ recording to be
68active at one time.
69This was necessary to allow for multiple threading applications.
70
71$head Order$$
72$index ADFun, Order$$
73$index Order, ADFun$$
74The result $icode o$$ has prototype
75$codei%
76        size_t %o%
77%$$
78and is the order of the previous forward operation
79using the function $icode f$$.
80This is the highest order of the
81$cref/Taylor coefficients/glossary/Taylor Coefficient/$$
82that are currently stored in $icode f$$.
83
84$subhead Deprecated 2006-03-31$$
85Zero order corresponds to function values being stored in $icode f$$.
86In the future, we would like to be able to erase the function
87values so that $icode f$$ uses less memory.
88In this case, the return value of $code Order$$ would not make sense.
89Use $cref size_order$$ to obtain
90the number of Taylor coefficients currently stored
91in the ADFun object $icode f$$
92(which is equal to the order plus one).
93
94
95$head Memory$$
96$index ADFun, Memory$$
97$index Memory, ADFun$$
98The result
99$codei%
100        size_t %m%
101%$$
102and is the number of memory units ($code sizeof$$) required for the
103information currently stored in $icode f$$.
104This memory is returned to the system when the destructor for
105$icode f$$ is called.
106
107$subhead Deprecated 2006-03-31$$
108It used to be the case that an ADFun object just kept increasing its
109buffers to the maximum size necessary during its lifetime.
110It would then return the buffers to the system when its destructor
111was called.
112This is no longer the case, an ADFun object now returns memory
113when it no longer needs the values stored in that memory.
114Thus the $code Memory$$ function is no longer well defined.
115
116$head Size$$
117$index ADFun, Size$$
118$index Size, ADFun$$
119The result $icode s$$ has prototype
120$codei%
121        size_t %s%
122%$$
123and is the number of variables in the operation sequence plus the following:
124one for a phantom variable with tape address zero,
125one for each component of the domain that is a parameter.
126The amount of work and memory necessary for computing function values
127and derivatives using $icode f$$ is roughly proportional to $icode s$$.
128
129$subhead Deprecated 2006-04-03$$
130There are other sizes attached to an ADFun object, for example,
131the number of operations in the sequence.
132In order to avoid confusion with these other sizes,
133use $cref/size_var/seq_property/size_var/$$ to obtain
134the number of variables in the operation sequence.
135
136$head taylor_size$$
137$index ADFun, taylor_size$$
138$index taylor_size, ADFun$$
139The result $icode t$$ has prototype
140$codei%
141        size_t %t%
142%$$
143and is the number of Taylor coefficient orders
144currently calculated and stored in the ADFun object $icode f$$.
145
146$subhead Deprecated 2006-06-17$$
147This function has been replaced by $cref size_order$$.
148
149$head use_VecAD$$
150$index ADFun, use_VecAD$$
151$index use_VecAD, ADFun$$
152The result $icode u$$ has prototype
153$codei%
154        bool %u%
155%$$
156If it is true, the
157AD of $icode Base$$
158$cref/operation sequence/glossary/Operation/Sequence/$$
159stored in $icode f$$ contains
160$cref/VecAD/VecAD/VecAD<Base>::reference/$$ operands.
161Otherwise $icode u$$ is false.
162
163$subhead Deprecated 2006-04-08$$
164You can instead use
165$codei%
166        %u% = %f%.size_VecAD() > 0
167%$$
168
169$head size_taylor$$
170$index ADFun, size_taylor$$
171$index size_taylor, ADFun$$
172The result $icode v$$ has prototype
173$codei%
174        size_t %v%
175%$$
176and is the number of Taylor coefficient orders
177currently calculated and stored in the ADFun object $icode f$$.
178
179$subhead Deprecated 2014-03-18$$
180This function has been replaced by $cref size_order$$.
181
182$head capacity_taylor$$
183$index ADFun, capacity_taylor$$
184$index capacity_taylor, ADFun$$
185The result $icode w$$ has prototype
186$codei%
187        size_t %w%
188%$$
189and is the number of Taylor coefficient orders currently allocated
190in the ADFun object $icode f$$.
191
192$subhead Deprecated 2014-03-18$$
193This function has been replaced by $cref capacity_order$$.
194
195
196$end
Note: See TracBrowser for help on using the repository browser.