RuntimeOptions

✖
`RuntimeOptions`

✖

is an option for Compile that specifies runtime settings for the compiled function it creates.

Details

RuntimeOptions applies to the execution of the compiled function.
RuntimeOptions can take the following overall settings:
"Quality" optimize for quality of final results

"Speed" optimize for speed of getting results
RuntimeOptions can also take the following nested settings:

	"CatchMachineOverflow"	False	whether real overflow should be caught as it happens
	"CatchMachineIntegerOverflow"	True	whether integer overflow should be caught
	"CompareWithTolerance"	True	whether comparisons should work similarly to SameQ
	"EvaluateSymbolically"	True	whether to evaluate with symbolic arguments
	"RuntimeErrorHandler"	Evaluate	a function to apply if there is a fatal runtime error executing the function
	"WarningMessages"	True	whether warning messages should be emitted

RuntimeOptions->"Speed" is equivalent to the following nested settings:

	"CatchMachineOverflow"	False
	"CatchMachineIntegerOverflow"	False
	"CompareWithTolerance"	False
	"EvaluateSymbolically"	True
	"RuntimeErrorHandler"	Evaluate
	"WarningMessages"	True

RuntimeOptions->"Quality" is equivalent to the following nested settings:

	"CatchMachineOverflow"	True
	"CatchMachineIntegerOverflow"	True
	"CompareWithTolerance"	True
	"EvaluateSymbolically"	True
	"RuntimeErrorHandler"	Evaluate
	"WarningMessages"	True

Examples

open allclose all

Basic Examples (1)Summary of the most common use cases

Typically, integer arithmetic overflow is caught and the computation switches to use bignums:

In[1]:=1

✖

https://wolfram.com/xid/0v5z4s5btewlv-jw23o

Out[1]=1

Turning off runtime checks leads to maximum speed but the result can be incorrect if the numbers overflow:

In[2]:=2

✖

https://wolfram.com/xid/0v5z4s5btewlv-hro72

Out[2]=2

Options (5)Common values & functionality for each option

CatchMachineIntegerOverflow (1)

Typically, machine integer overflow is caught and generates a runtime error:

In[1]:=1

✖

https://wolfram.com/xid/0v5z4s5btewlv-bkaj6j

Out[1]=1

Turning off machine integer overflow checking leads to faster results, which may be incorrect in some cases:

In[2]:=2

✖

https://wolfram.com/xid/0v5z4s5btewlv-fqdx81

Out[2]=2

RuntimeErrorHandler (1)

The "RuntimeErrorHandler" setting is used when there is a runtime error:

In[1]:=1

✖

https://wolfram.com/xid/0v5z4s5btewlv-dr181

With no error, the compiled function works as normal:

In[2]:=2

✖

https://wolfram.com/xid/0v5z4s5btewlv-by9gca

Out[2]=2

If there is a runtime error, the function behaves differently:

In[3]:=3

✖

https://wolfram.com/xid/0v5z4s5btewlv-cmhh3s

Out[3]=3

EvaluateSymbolically (3)

The default is to evaluate the function symbolically with symbolic arguments:

In[1]:=1

✖

https://wolfram.com/xid/0v5z4s5btewlv-e8thqu

Out[1]=1

With "EvaluateSymbolically"->False, the function returns unevaluated:

In[2]:=2

✖

https://wolfram.com/xid/0v5z4s5btewlv-d3cu59

Out[2]=2

This evaluates if the symbolic argument is replaced with a number:

In[3]:=3

✖

https://wolfram.com/xid/0v5z4s5btewlv-irfp3u

Out[3]=3

Sometimes symbolic evaluation does not give what you intend:

In[1]:=1

✖

https://wolfram.com/xid/0v5z4s5btewlv-c5iunw

Out[1]=1

Preventing symbolic evaluation keeps the original intent:

In[2]:=2

✖

https://wolfram.com/xid/0v5z4s5btewlv-ebqyiu

Out[2]=2

In[3]:=3

✖

https://wolfram.com/xid/0v5z4s5btewlv-i51ly

Out[3]=3

Symbolic evaluation may be slow for expressions that expand out:

In[1]:=1

✖

https://wolfram.com/xid/0v5z4s5btewlv-eesbc1

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/0v5z4s5btewlv-e8ru5l

Out[2]=2

Top