Changeset 2920
 Timestamp:
 Oct 11, 2013 8:40:52 AM (6 years ago)
 Location:
 trunk/cppad/local
 Files:

 3 edited
Legend:
 Unmodified
 Added
 Removed

trunk/cppad/local/cond_op.hpp
r2918 r2920 22 22 23 23 /*! 24 Common documentation for conditional expressions forward and reverse mode.24 Shared documentation for conditional expressions (not called). 25 25 26 26 <! define conditional_exp_op > … … 112 112 113 113 /*! 114 Common documentation for conditional expression sparse operations.114 Shared documentation for conditional expression sparse operations (not called). 115 115 116 116 <! define sparse_conditional_exp_op > 
trunk/cppad/local/load_op.hpp
r2919 r2920 24 24 25 25 /*! 26 Prototype for zero order forward mode implementation of op = LdpOp or LdvOp. 26 Shared documentation for zero order forward mode implementation of 27 op = LdpOp or LdvOp (not called). 27 28 28 29 The C++ source code corresponding to this operation is … … 142 143 } 143 144 /*! 144 Prototype sparsity operations corresponding to op = LdpOp or LdvOp. 145 Shared documentation for sparsity operations corresponding to 146 op = LdpOp or LdvOp (not called). 145 147 146 148 <! define sparse_load_op > 
trunk/cppad/local/optimize.hpp
r2910 r2920 221 221 222 222 /*! 223 Documents arguments that are common to optimization helper functions 224 (should not be called). 225 223 Shared documentation for optimization helper functions (not called). 224 225 <! define optimize_prototype > 226 226 \param tape 227 227 is a vector that maps a variable index, in the old operation sequence, … … 268 268 given a parameter index \c i, the corresponding parameter value is 269 269 <tt>par[i]</tt>. 270 <! end optimize_prototype > 270 271 */ 271 272 template <class Base> … … 283 284 can be used inplace of the result for current operator. 284 285 285 \copydetails optimize_prototype 286 <! replace optimize_prototype > 287 \param tape 288 is a vector that maps a variable index, in the old operation sequence, 289 to an <tt>optimize_old_variable</tt> information record. 290 Note that the index for this vector must be greater than or equal zero and 291 less than <tt>tape.size()</tt>. 292 293 \li <tt>tape[i].op</tt> 294 is the operator in the old operation sequence 295 corresponding to the old variable index \c i. 296 Assertion: <tt>NumRes(tape[i].op) > 0</tt>. 297 298 \li <tt>tape[i].arg</tt> 299 for <tt>j < NumArg( tape[i].op ), tape[i].arg[j]</tt> 300 is the jth the argument, in the old operation sequence, 301 corresponding to the old variable index \c i. 302 Assertion: <tt>tape[i].arg[j] < i</tt>. 303 304 \li <tt>tape[i].new_var</tt> 305 Suppose 306 <tt>i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j]</tt>, 307 and \c j corresponds to a variable for operator <tt>tape[i].op</tt>. 308 It follows that <tt>tape[k].new_var</tt> 309 has alread been set to the variable in the new operation sequence 310 corresponding to the old variable index \c k. 311 This means that the \c new_var value has been set 312 for all the possible arguments that come before \a current. 313 314 \param current 315 is the index in the old operation sequence for 316 the variable corresponding to the result for the current operator. 317 Assertions: 318 <tt> 319 current < tape.size(), 320 NumRes( tape[current].op ) > 0. 321 </tt> 322 323 \param npar 324 is the number of parameters corresponding to this operation sequence. 325 326 \param par 327 is a vector of length \a npar containing the parameters 328 for this operation sequence; i.e., 329 given a parameter index \c i, the corresponding parameter value is 330 <tt>par[i]</tt>. 331 <! end optimize_prototype > 286 332 287 333 \param hash_table_var … … 343 389 Check a binary operator for a complete match with a previous operator, 344 390 345 \copydetails optimize_unary_match 391 <! replace optimize_prototype > 392 \param tape 393 is a vector that maps a variable index, in the old operation sequence, 394 to an <tt>optimize_old_variable</tt> information record. 395 Note that the index for this vector must be greater than or equal zero and 396 less than <tt>tape.size()</tt>. 397 398 \li <tt>tape[i].op</tt> 399 is the operator in the old operation sequence 400 corresponding to the old variable index \c i. 401 Assertion: <tt>NumRes(tape[i].op) > 0</tt>. 402 403 \li <tt>tape[i].arg</tt> 404 for <tt>j < NumArg( tape[i].op ), tape[i].arg[j]</tt> 405 is the jth the argument, in the old operation sequence, 406 corresponding to the old variable index \c i. 407 Assertion: <tt>tape[i].arg[j] < i</tt>. 408 409 \li <tt>tape[i].new_var</tt> 410 Suppose 411 <tt>i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j]</tt>, 412 and \c j corresponds to a variable for operator <tt>tape[i].op</tt>. 413 It follows that <tt>tape[k].new_var</tt> 414 has alread been set to the variable in the new operation sequence 415 corresponding to the old variable index \c k. 416 This means that the \c new_var value has been set 417 for all the possible arguments that come before \a current. 418 419 \param current 420 is the index in the old operation sequence for 421 the variable corresponding to the result for the current operator. 422 Assertions: 423 <tt> 424 current < tape.size(), 425 NumRes( tape[current].op ) > 0. 426 </tt> 427 428 \param npar 429 is the number of parameters corresponding to this operation sequence. 430 431 \param par 432 is a vector of length \a npar containing the parameters 433 for this operation sequence; i.e., 434 given a parameter index \c i, the corresponding parameter value is 435 <tt>par[i]</tt>. 436 <! end optimize_prototype > 437 438 \param hash_table_var 439 is a vector with size CPPAD_HASH_TABLE_SIZE 440 that maps a hash code to the corresponding 441 variable index in the old operation sequence. 442 All the values in this table must be less than \a current. 443 444 \param code 445 The input value of code does not matter. 446 The output value of code is the hash code corresponding to 447 this operation in the new operation sequence. 448 449 \return 450 If the return value is zero, 451 no match was found. 452 If the return value is greater than zero, 453 it is the index of a new variable that can be used to replace the 454 old variable. 455 346 456 347 457 \par Restrictions: 348 458 The binary operator must be an addition, subtraction, multiplication, division 349 or power operator. 459 or power operator. NumArg( tape[current].op ) == 1. 350 460 */ 351 461 template <class Base> … … 478 588 Record an operation of the form (parameter op variable). 479 589 480 \copydetails optimize_prototype 590 <! replace optimize_prototype > 591 \param tape 592 is a vector that maps a variable index, in the old operation sequence, 593 to an <tt>optimize_old_variable</tt> information record. 594 Note that the index for this vector must be greater than or equal zero and 595 less than <tt>tape.size()</tt>. 596 597 \li <tt>tape[i].op</tt> 598 is the operator in the old operation sequence 599 corresponding to the old variable index \c i. 600 Assertion: <tt>NumRes(tape[i].op) > 0</tt>. 601 602 \li <tt>tape[i].arg</tt> 603 for <tt>j < NumArg( tape[i].op ), tape[i].arg[j]</tt> 604 is the jth the argument, in the old operation sequence, 605 corresponding to the old variable index \c i. 606 Assertion: <tt>tape[i].arg[j] < i</tt>. 607 608 \li <tt>tape[i].new_var</tt> 609 Suppose 610 <tt>i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j]</tt>, 611 and \c j corresponds to a variable for operator <tt>tape[i].op</tt>. 612 It follows that <tt>tape[k].new_var</tt> 613 has alread been set to the variable in the new operation sequence 614 corresponding to the old variable index \c k. 615 This means that the \c new_var value has been set 616 for all the possible arguments that come before \a current. 617 618 \param current 619 is the index in the old operation sequence for 620 the variable corresponding to the result for the current operator. 621 Assertions: 622 <tt> 623 current < tape.size(), 624 NumRes( tape[current].op ) > 0. 625 </tt> 626 627 \param npar 628 is the number of parameters corresponding to this operation sequence. 629 630 \param par 631 is a vector of length \a npar containing the parameters 632 for this operation sequence; i.e., 633 given a parameter index \c i, the corresponding parameter value is 634 <tt>par[i]</tt>. 635 <! end optimize_prototype > 481 636 482 637 \param rec … … 532 687 Record an operation of the form (variable op parameter). 533 688 534 \copydetails optimize_prototype 689 <! replace optimize_prototype > 690 \param tape 691 is a vector that maps a variable index, in the old operation sequence, 692 to an <tt>optimize_old_variable</tt> information record. 693 Note that the index for this vector must be greater than or equal zero and 694 less than <tt>tape.size()</tt>. 695 696 \li <tt>tape[i].op</tt> 697 is the operator in the old operation sequence 698 corresponding to the old variable index \c i. 699 Assertion: <tt>NumRes(tape[i].op) > 0</tt>. 700 701 \li <tt>tape[i].arg</tt> 702 for <tt>j < NumArg( tape[i].op ), tape[i].arg[j]</tt> 703 is the jth the argument, in the old operation sequence, 704 corresponding to the old variable index \c i. 705 Assertion: <tt>tape[i].arg[j] < i</tt>. 706 707 \li <tt>tape[i].new_var</tt> 708 Suppose 709 <tt>i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j]</tt>, 710 and \c j corresponds to a variable for operator <tt>tape[i].op</tt>. 711 It follows that <tt>tape[k].new_var</tt> 712 has alread been set to the variable in the new operation sequence 713 corresponding to the old variable index \c k. 714 This means that the \c new_var value has been set 715 for all the possible arguments that come before \a current. 716 717 \param current 718 is the index in the old operation sequence for 719 the variable corresponding to the result for the current operator. 720 Assertions: 721 <tt> 722 current < tape.size(), 723 NumRes( tape[current].op ) > 0. 724 </tt> 725 726 \param npar 727 is the number of parameters corresponding to this operation sequence. 728 729 \param par 730 is a vector of length \a npar containing the parameters 731 for this operation sequence; i.e., 732 given a parameter index \c i, the corresponding parameter value is 733 <tt>par[i]</tt>. 734 <! end optimize_prototype > 535 735 536 736 \param rec … … 583 783 Record an operation of the form (variable op variable). 584 784 585 \copydetails optimize_prototype 785 <! replace optimize_prototype > 786 \param tape 787 is a vector that maps a variable index, in the old operation sequence, 788 to an <tt>optimize_old_variable</tt> information record. 789 Note that the index for this vector must be greater than or equal zero and 790 less than <tt>tape.size()</tt>. 791 792 \li <tt>tape[i].op</tt> 793 is the operator in the old operation sequence 794 corresponding to the old variable index \c i. 795 Assertion: <tt>NumRes(tape[i].op) > 0</tt>. 796 797 \li <tt>tape[i].arg</tt> 798 for <tt>j < NumArg( tape[i].op ), tape[i].arg[j]</tt> 799 is the jth the argument, in the old operation sequence, 800 corresponding to the old variable index \c i. 801 Assertion: <tt>tape[i].arg[j] < i</tt>. 802 803 \li <tt>tape[i].new_var</tt> 804 Suppose 805 <tt>i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j]</tt>, 806 and \c j corresponds to a variable for operator <tt>tape[i].op</tt>. 807 It follows that <tt>tape[k].new_var</tt> 808 has alread been set to the variable in the new operation sequence 809 corresponding to the old variable index \c k. 810 This means that the \c new_var value has been set 811 for all the possible arguments that come before \a current. 812 813 \param current 814 is the index in the old operation sequence for 815 the variable corresponding to the result for the current operator. 816 Assertions: 817 <tt> 818 current < tape.size(), 819 NumRes( tape[current].op ) > 0. 820 </tt> 821 822 \param npar 823 is the number of parameters corresponding to this operation sequence. 824 825 \param par 826 is a vector of length \a npar containing the parameters 827 for this operation sequence; i.e., 828 given a parameter index \c i, the corresponding parameter value is 829 <tt>par[i]</tt>. 830 <! end optimize_prototype > 586 831 587 832 \param rec … … 638 883 Recording a cummulative cummulative summation starting at its highest parrent. 639 884 640 \copydetails optimize_prototype 885 <! replace optimize_prototype > 886 \param tape 887 is a vector that maps a variable index, in the old operation sequence, 888 to an <tt>optimize_old_variable</tt> information record. 889 Note that the index for this vector must be greater than or equal zero and 890 less than <tt>tape.size()</tt>. 891 892 \li <tt>tape[i].op</tt> 893 is the operator in the old operation sequence 894 corresponding to the old variable index \c i. 895 Assertion: <tt>NumRes(tape[i].op) > 0</tt>. 896 897 \li <tt>tape[i].arg</tt> 898 for <tt>j < NumArg( tape[i].op ), tape[i].arg[j]</tt> 899 is the jth the argument, in the old operation sequence, 900 corresponding to the old variable index \c i. 901 Assertion: <tt>tape[i].arg[j] < i</tt>. 902 903 \li <tt>tape[i].new_var</tt> 904 Suppose 905 <tt>i <= current, j < NumArg( tape[i].op ), and k = tape[i].arg[j]</tt>, 906 and \c j corresponds to a variable for operator <tt>tape[i].op</tt>. 907 It follows that <tt>tape[k].new_var</tt> 908 has alread been set to the variable in the new operation sequence 909 corresponding to the old variable index \c k. 910 This means that the \c new_var value has been set 911 for all the possible arguments that come before \a current. 912 913 \param current 914 is the index in the old operation sequence for 915 the variable corresponding to the result for the current operator. 916 Assertions: 917 <tt> 918 current < tape.size(), 919 NumRes( tape[current].op ) > 0. 920 </tt> 921 922 \param npar 923 is the number of parameters corresponding to this operation sequence. 924 925 \param par 926 is a vector of length \a npar containing the parameters 927 for this operation sequence; i.e., 928 given a parameter index \c i, the corresponding parameter value is 929 <tt>par[i]</tt>. 930 <! end optimize_prototype > 641 931 642 932 \param rec
Note: See TracChangeset
for help on using the changeset viewer.