Skip to content

Commit

Permalink
Document fast math
Browse files Browse the repository at this point in the history
  • Loading branch information
eschnett committed Jan 9, 2015
1 parent 73cf5fc commit c0f5e2e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/man/julia.1
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,11 @@ Enable or disable color text
--check-bounds={yes|no}
Emit bounds checks always or never (ignoring declarations)

.TP
--math-mode={ieee|user}
Always use IEEE semantics for math (ignoring declarations),
or adhere to declarations in source code

.TP
--int-literals={32|64}
Select integer literal size independent of platform
Expand Down
2 changes: 2 additions & 0 deletions doc/manual/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@ those available for the ``perl`` and ``ruby`` programs::
--track-allocation={none|user|all}
Count bytes allocated by each source line
--check-bounds={yes|no} Emit bounds checks always or never (ignoring declarations)
--math-mode={ieee|user} Always use IEEE semantics for math (ignoring declarations),
or adhere to declarations in source code
-O, --optimize Run time-intensive code optimizations
--int-literals={32|64} Select integer literal size independent of platform
--dump-bitcode={yes|no} Dump bitcode for the system image (used with --build)
Expand Down
4 changes: 4 additions & 0 deletions doc/manual/performance-tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,10 @@ properties.
- Use :obj:`@inbounds` to eliminate array bounds checking within expressions.
Be certain before doing this. If the subscripts are ever out of bounds,
you may suffer crashes or silent corruption.
- Use :obj:`@fastmath` to allow floating point optimizations that are
correct for real numbers, but lead to differences for IEEE numbers.
Be careful when doing this, as this may change numerical results.
This corresponds to the ``-ffast-math`` option of clang.
- Write :obj:`@simd` in front of ``for`` loops that are amenable to vectorization.
**This feature is experimental** and could change or disappear in future
versions of Julia.
Expand Down

0 comments on commit c0f5e2e

Please sign in to comment.