Changeset 3631


Ignore:
Timestamp:
Feb 2, 2015 7:25:35 AM (5 years ago)
Author:
bradbell
Message:

merge to branch: trunk
from repository: https://github.com/coin-or/CppAD
start hash code: 4a94278cacc91a9e8e1934659b38caafb940dec8
end hash code: 0b3fffdf3f2e526733a5f3912a5b2cdc68187113

commit 0b3fffdf3f2e526733a5f3912a5b2cdc68187113
Author: Brad Bell <bradbell@…>
Date: Mon Feb 2 05:21:57 2015 -0700

whats_new_15.omh: remove trailing white space.

commit 64aa0a1c680e4a4d409b17958010f58cedb44aed
Author: Brad Bell <bradbell@…>
Date: Mon Feb 2 05:21:08 2015 -0700

whats_new_15.omh: user's view of recent changes to cmake.omh.

commit e775bce7688ab13e26de77f8185ba8e7e71d113a
Author: Brad Bell <bradbell@…>
Date: Mon Feb 2 05:13:37 2015 -0700

cmake.omh: edit cmake_install_docdir.

commit 980bad009106be3b7466d30c0b257345daf11fc5
Author: Brad Bell <bradbell@…>
Date: Mon Feb 2 05:02:44 2015 -0700

cmake.omh: edit cmake_install_datadir.

commit da7ce3700fc2d61da3cb8d6a933b18af4d5bec62
Author: Brad Bell <bradbell@…>
Date: Mon Feb 2 04:51:54 2015 -0700

cmake.omh: edit cmake_install_libdirs.

commit 6c19b7743f2cf039e7d30b80cac4038ce91dda1b
Author: Brad Bell <bradbell@…>
Date: Sun Feb 1 13:23:18 2015 -0700

cmake.omh: remove trailing white space.

commit a6936b4d4441e756980369f4fcdfeae39cf09893
Author: Brad Bell <bradbell@…>
Date: Sun Feb 1 13:21:57 2015 -0700

cmake.omh: edit cmake_install_includedirs.

commit 91565c58571ac96f4b82eb82570e0438ab9603a2
Author: Brad Bell <bradbell@…>
Date: Sun Feb 1 13:07:47 2015 -0700

cmake.omh: edit cmake_install_postfix.

commit bdeefe2a9dcda87c5f9c4a734b21a87154cb8e27
Author: Brad Bell <bradbell@…>
Date: Sun Feb 1 13:01:05 2015 -0700

cmake.omh: edit cmake_install_prefix.

commit b1b1796786b1cee3928a32baf3774d53507236f2
Author: Brad Bell <bradbell@…>
Date: Sun Feb 1 07:30:06 2015 -0700

cmake.omh: move postfix next to prefix, more grouping in cmake command.

commit 5ad40c832ecbef31cd2fd19e1a2ce22fc794b490
Author: Brad Bell <bradbell@…>
Date: Sun Feb 1 07:18:14 2015 -0700

cmake.omh: remove tabs from comand, move libdirs next to includedirs.

Location:
trunk/omh
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/omh/install/cmake.omh

    r3476 r3631  
    44
    55CppAD is distributed under multiple licenses. This distribution is under
    6 the terms of the 
     6the terms of the
    77                    Eclipse Public License Version 1.0.
    88
     
    5050        includedirs
    5151        libdirs
    52         cxx 
     52        cxx
    5353        max num
    5454        postfix
     
    6565$head The CMake Program$$
    6666$index cmake$$
    67 The 
    68 $href%http://www.cmake.org/cmake/help/install.html%cmake%$$ 
     67The
     68$href%http://www.cmake.org/cmake/help/install.html%cmake%$$
    6969program enables one to create a single set of scripts,
    70 called $code CMakeLists.txt$$, 
     70called $code CMakeLists.txt$$,
    7171that can be used to test and install a program on Unix, Microsoft, or
    72 Apple operating systems. 
     72Apple operating systems.
    7373For example, one can use it to automatically generate Microsoft project files.
    74    
     74
    7575$head CMake Command$$
    7676$index cmake, command$$
     
    7878$index cppad, configure$$
    7979The command below assumes that $code cmake$$ is in your execution
    80 path. If not, you can put the path to $code cmake$$ in font the command. 
     80path. If not, you can put the path to $code cmake$$ in font the command.
    8181Only the $code cmake$$ command and the path to the distribution directory
    8282($code ..$$ at the end of the command below) are required.
     
    8585
    8686$subhead Build Directory$$
    87 Create a $code build$$ subdirectory of the 
     87Create a $code build$$ subdirectory of the
    8888$cref/distribution directory/download/Distribution Directory/$$,
    89 change into the $code build$$  directory, 
     89change into the $code build$$  directory,
    9090and execute the following command:
    9191$codei%
    92 cmake %%                                                                      \
    93         -G %generator%                                                           \
    94         -D cmake_install_prefix=%cmake_install_prefix%                           \
    95         -D cmake_install_includedirs=%cmake_install_includedirs%                 \
    96         -D cmake_install_datadir=%cmake_install_datadir%                         \
    97         -D cmake_install_docdir=%cmake_install_docdir%                           \
    98         -D cmake_install_libdirs=%cmake_install_libdirs%                         \
    99         -D cmake_install_postfix=%cmake_install_postfix%                         \
     92cmake %%                                                                     \
     93    -G %generator%                                                           \
    10094        \
    101         -D adolc_prefix=%adolc_prefix%                                           \
    102         -D colpack_prefix=%colpack_prefix%                                       \
    103         -D eigen_prefix=%eigen_prefix%                                           \
    104         -D fadbad_prefix=%fadbad_prefix%                                         \
    105         -D ipopt_prefix=%ipopt_prefix%                                           \
    106         -D sacado_prefix=%sacado_prefix%                                         \
     95    -D cmake_install_prefix=%cmake_install_prefix%                           \
     96    -D cmake_install_postfix=%cmake_install_postfix%                         \
    10797        \
    108         -D cppad_cxx_flags=%cppad_cxx_flags%                                     \
     98    -D cmake_install_includedirs=%cmake_install_includedirs%                 \
     99    -D cmake_install_libdirs=%cmake_install_libdirs%                         \
    109100        \
    110         -D cppad_testvector=%cppad_testvector%                                   \
    111         -D cppad_max_num_threads=%cppad_max_num_threads%                         \
    112         -D cppad_sparse_list=%cppad_sparse_list%                                 \
    113         -D cppad_tape_id_type=%cppad_tape_id_type%                               \
    114         -D cppad_tape_addr_type=%cppad_tape_addr_type%                           \
    115         -D cppad_implicit_ctor_from_any_type=%cppad_implicit_ctor_from_any_type% \
    116         \
    117         ..
     101    -D cmake_install_datadir=%cmake_install_datadir%                         \
     102    -D cmake_install_docdir=%cmake_install_docdir%                           \
     103    \
     104    -D adolc_prefix=%adolc_prefix%                                           \
     105    -D colpack_prefix=%colpack_prefix%                                       \
     106    -D eigen_prefix=%eigen_prefix%                                           \
     107    -D fadbad_prefix=%fadbad_prefix%                                         \
     108    -D ipopt_prefix=%ipopt_prefix%                                           \
     109    -D sacado_prefix=%sacado_prefix%                                         \
     110    \
     111    -D cppad_cxx_flags=%cppad_cxx_flags%                                     \
     112    \
     113    -D cppad_testvector=%cppad_testvector%                                   \
     114    -D cppad_max_num_threads=%cppad_max_num_threads%                         \
     115    -D cppad_sparse_list=%cppad_sparse_list%                                 \
     116    -D cppad_tape_id_type=%cppad_tape_id_type%                               \
     117    -D cppad_tape_addr_type=%cppad_tape_addr_type%                           \
     118    -D cppad_implicit_ctor_from_any_type=%cppad_implicit_ctor_from_any_type% \
     119    \
     120    ..
    118121%$$
    119122
     
    128131$code "NMake Makefiles"$$  $cnext make files for Visual Studio
    129132$tend
    130 Other generator choices are available; see the cmake 
     133Other generator choices are available; see the cmake
    131134$href%http://www.cmake.org/cmake/help/cmake2.6docs.html#section_Generators%
    132135generators%$$ documentation.
     
    135138$index install, prefix$$
    136139$index prefix, install$$
    137 This is the prefix directory for the CppAD files that get installed by the
     140This is the top level absolute path below which
     141all of the CppAD files are installed by the command
    138142$codei%
    139143        make install
    140144%$$
    141 All of the installed files will be placed below this directory.
    142 The default value for this directory is $code /usr$$.
    143 
    144 $head cmake_install_includedirs$$
    145 $index install, include directories$$
    146 $index include directories, install$$
    147 This can be one directory, or a list of directories separated
    148 by spaces or by semi-colons.
    149 This first entry in the list is the directory,
    150 below the $icode cmake_install_prefix$$,
    151 where the CppAD include files will be installed.
    152 This directory, and the others in the list, are used for searching
    153 for include files.
    154 The default value for this directory list is $code include$$.
    155 For example, if
    156 $icode cmake_install_prefix$$,
    157 $icode cmake_install_includedirs$$, and
    158 $icode cmake_install_postfix$$, are not specified,
    159 the file $code cppad.hpp$$ will be installed in the location
     145For example,
     146if $icode cmake_install_prefix$$ is $code /usr$$,
     147$icode cmake_install_includedirs$$ is $code include$$, and
     148$icode cmake_install_postfix$$ is not specified,
     149the file $code cppad.hpp$$ is installed in the location
    160150$codei%
    161151        /usr/include/cppad/cppad.hpp
    162152%$$
    163 
    164 $head cmake_install_datadir$$
    165 $index install, data directory$$
    166 $index data directory, install$$
    167 This is the directory,
    168 below the $icode cmake_install_prefix$$,
    169 where the data files will be installed.
    170 The default value for this directory is $code share$$.
    171 For example, if
    172 $icode cmake_install_prefix$$ and
    173 $icode cmake_install_postfix$$ are not specified,
    174 the $cref pkgconfig$$ file $code cppad.pc$$ will be installed in the location
    175 $codei%
    176         /usr/share/pkgconfig/cppad.pc
    177 %$$
    178 
    179 $head cmake_install_docdir$$
    180 $index install, data directory$$
    181 $index data directory, install$$
    182 This is the directory is present, the documentation files are installed
    183 in this sub-directory below the $icode cmake_install_prefix$$.
    184 For example, if
    185 $icode cmake_install_prefix$$ and
    186 $icode cmake_install_postfix$$ are not specified, and
    187 $codei%
    188         -D cmake_install_docdir=share/doc
    189 %$$
    190 the file $code cppad.xml$$ will be installed in the location
    191 $codei%
    192         /usr/share/doc/cppad/cppad.xml
    193 %$$
    194 
    195 $head cmake_install_libdirs$$
    196 $index install, library directories$$
    197 $index library directories, install$$
    198 This can be one directory, or a list of directories separated
    199 by spaces or semi-colons.
    200 The first entry in the list is the directory,
    201 below the $icode cmake_install_prefix$$,
    202 where the CppAD library files will be installed.
    203 This directory, and the others in the list, are used for searching
    204 for library files.
    205 The default value for this directory list is $code lib$$.
    206 For example, if
    207 $icode cmake_install_prefix$$,
    208 $icode cmake_install_postfix$$,
    209 $icode cmake_install_libdirs$$ are not specified, and
    210 $icode ipopt_prefix$$ is specified,
    211 the file $code libcppad_ipopt.a$$ will be installed in the location
    212 $codei%
    213         /usr/lib/libcppad_ipopt.a
    214 %$$
     153The default value for $icode cmake_install_prefix$$ is $code /usr$$.
    215154
    216155$head cmake_install_postfix$$
    217156$index install, postfix$$
    218157$index postfix, install$$
    219 This is the directory,
    220 below the include, data, and library directories,
    221 where files will be installed.
    222 The default value for this directory is empty
    223 (as the example cases above demonstrate).
    224 For example,
    225 if $icode cmake_install_prefix$$ and
    226 $icode cmake_install_postfix$$ are not specified, and
    227 $codei%
    228         -D cmake_install_postfix=coin
    229 %$$
    230 the $cref pkgconfig$$ file $code cppad.pc$$ will be installed in the location
    231 $codei%
    232         /usr/share/coin/pkgconfig/cppad.pc
    233 %$$
     158This is the bottom level relative path below which
     159all of the CppAD files are installed.
     160For example,
     161if $icode cmake_install_prefix$$ is $code /usr$$,
     162$icode cmake_install_includedirs$$ is $code include$$, and
     163$icode cmake_install_postfix$$ is $code coin$$,
     164the file $code cppad.hpp$$ is installed in the location
     165$codei%
     166        /usr/include/coin/cppad/cppad.hpp
     167%$$
     168The default value for $icode cmake_install_postfix$$ is empty; i.e,
     169there is no bottom level relative directory for the installed files.
     170
     171
     172$head cmake_install_includedirs$$
     173$index install, include directories$$
     174$index include, install directories$$
     175This is one directory, or a list of directories separated
     176by spaces or by semi-colons.
     177This first entry in the list is the middle level relative path below which
     178the CppAD include files are installed.
     179The entire list is used for searching for include files.
     180For example,
     181if $icode cmake_install_prefix$$ is $code /usr$$,
     182$icode cmake_install_includedirs$$ is $code include$$, and
     183$icode cmake_install_postfix$$ is not specified,
     184the file $code cppad.hpp$$ is installed in the location
     185$codei%
     186        /usr/include/cppad/cppad.hpp
     187%$$
     188The default value for this directory list is $code include$$.
     189
     190
     191$head cmake_install_libdirs$$
     192$index install, lib directories$$
     193$index lib, install directories$$
     194This is one directory, or a list of directories separated
     195by spaces or by semi-colons.
     196This first entry in the list is the middle level relative path below which
     197the CppAD library files are installed.
     198The entire list is used for searching for library files.
     199For example,
     200if $icode cmake_install_prefix$$ is $code /usr$$,
     201$icode cmake_install_libdirs$$ is $code lib$$,
     202$icode cmake_install_postfix$$ is not specified,
     203and $icode ipopt_prefix$$ is specified,
     204the file $code libcppad_ipopt.a$$ is installed in the location
     205$codei%
     206        /usr/lib/libcppad_ipopt.a
     207%$$
     208The default value for this directory list is $code lib$$.
     209
     210$head cmake_install_datadir$$
     211$index install, datadir$$
     212$index datadir, install$$
     213This is the middle level relative path below which
     214the CppAD data files are installed.
     215For example,
     216if $icode cmake_install_prefix$$ is $code /usr$$,
     217$icode cmake_install_datadir$$ is $code share$$, and
     218$icode cmake_install_postfix$$ is not specified,
     219the $cref pkgconfig$$ file $code cppad.pc$$ is installed in the location
     220$codei%
     221        /usr/share/pkgconfig/cppad.pc
     222%$$
     223The default value for $icode cmake_install_datadir$$ is $code share$$.
     224
     225$head cmake_install_docdir$$
     226$index install, documentation$$
     227$index documentation, install$$
     228This is the middle level relative path below which
     229the CppAD documentation files are installed.
     230For example,
     231if $icode cmake_install_prefix$$ is $code /usr$$,
     232$icode cmake_install_docdir$$ is $code share/doc$$, and
     233$icode cmake_install_postfix$$ is not specified,
     234the file $code cppad.xml$$ is installed in the location
     235$codei%
     236        /usr/share/doc/cppad/cppad.xml
     237%$$
     238There is no default value for $icode cmake_install_docdir$$.
     239If it is not specified, the documentation files are not installed.
    234240
    235241$head package_prefix$$
     
    284290$index sparsity, vector of sets$$
    285291There are two possible values for this option, $code YES$$ and $code NO$$.
    286 This affect the internal data structure used to store a 
     292This affect the internal data structure used to store a
    287293$cref/sparsity pattern/glossary/Sparsity Pattern/$$ when the
    288294users version of the sparsity pattern is a vector of $code std::set<size_t>$$.
     
    300306$index memory, tape$$
    301307$index tape, memory$$
    302 The type $icode cppad_tape_id_type$$ 
     308The type $icode cppad_tape_id_type$$
    303309is used for identifying different tapes.
    304310The valid values for this type are
     
    328334$index memory, tape$$
    329335$index tape, memory$$
    330 The type $icode cppad_tape_addr_type$$ 
     336The type $icode cppad_tape_addr_type$$
    331337is used for address in the AD recordings (tapes).
    332338The valid values for this argument are
     
    361367$index explicit, ctor$$
    362368The default value for $icode cppad_implicit_ctor_from_any_type$$ is $code NO$$.
    363 If it is $code YES$$, there is a 
     369If it is $code YES$$, there is a
    364370$cref/deprecated/ad_ctor/x/deprecated/$$
    365371implicit type constructor (type conversion)
    366372from any type to $codei%AD<%Base%>%$$.
    367 Otherwise this constructor is 
     373Otherwise this constructor is
    368374$cref/explicit/ad_ctor/x/explicit/$$.
    369375
  • trunk/omh/whats_new/whats_new_15.omh

    r3628 r3631  
    2424        cmake
    2525        hpp
     26        dir
     27        includedirs
     28        libdirs
     29        datadir
     30        docdir
    2631$$
    2732
     
    3338The purpose of this section is to
    3439assist you in learning about changes between various versions of CppAD.
     40
     41$head 02-02$$
     42Improve the documentation for the
     43$cref/cmake command/cmake/CMake Command/$$ line options
     44$codei%
     45        cmake_install_%dir%
     46%$$
     47for $icode dir$$ equal to
     48$code prefix$$, $code postfix$$, $code includedirs$$, $code libdirs$$,
     49$code datadir$$, and $code docdir$$.
    3550
    3651$head 01-30$$
     
    5873$head 01-21$$
    5974The deprecated $cref auto_tools$$ procedure had a bug in the
    60 detection of when the size of an $code unsigned int$$ 
     75detection of when the size of an $code unsigned int$$
    6176was the same as the size of a $code size_t$$. This has been fixed.
    6277
    6378$head 01-20$$
    6479$list number$$
    65 The new $cref compare_change$$ interface has been created 
    66 and the old $cref CompareChange$$ function has been deprecated; 
     80The new $cref compare_change$$ interface has been created
     81and the old $cref CompareChange$$ function has been deprecated;
    6782see the $cref compare_change.cpp$$ example.
    6883This enables one to determine the source code during taping
    69 that corresponds to changes in the comparisons during 
     84that corresponds to changes in the comparisons during
    7085$cref/zero order forward/forward_zero/$$ operations; see
    7186$cref/abort_op_index/Independent/abort_op_index/$$.
    7287
    7388$lnext
    74 This new $cref compare_change$$ interface can detect comparison changes 
    75 even if $cref/NDEBUG/Faq/Speed/NDEBUG/$$ is defined and 
     89This new $cref compare_change$$ interface can detect comparison changes
     90even if $cref/NDEBUG/Faq/Speed/NDEBUG/$$ is defined and
    7691even if $cref/f.optimize()/optimize/$$ has been called.
    7792The deprecated function $code CompareChange$$ used to always return zero after
     
    96111$cref/sparse Jacobian/link_sparse_jacobian/$$ test.
    97112$lnext
    98 For both the 
     113For both the
    99114$cref/sparse_jacobian/link_sparse_jacobian/$$ and
    100115$cref/sparse_hessian/link_sparse_hessian/$$ tests,
     
    117132The following changes were merged in from the $code color_hes$$ branch:
    118133$list number$$
    119 Specify the type of 
     134Specify the type of
    120135$cref/coloring/sparse_hessian/work/color_method/$$
    121 for the sparse hessian calculations. 
     136for the sparse hessian calculations.
    122137To be specific, instead of $code "cppad"$$ and $code "colpack"$$,
    123138the choices are $code "cppad.symmetric"$$, $code "cppad.general"$$,
    124139and $code "colpack.star"$$.
    125 This is not compatible with the change on 
    126 $cref/01-02/whats_new_15/01-02/$$, which was so recent 
     140This is not compatible with the change on
     141$cref/01-02/whats_new_15/01-02/$$, which was so recent
    127142that this should not be a problem.
    128143$lnext
Note: See TracChangeset for help on using the changeset viewer.