This is an archive of the discontinued LLVM Phabricator instance.

[LangRef] clarify semantics of the frem instruction
ClosedPublic

Authored by spatel on Nov 29 2017, 4:19 PM.

Reviewers

efriedma
Quolyk

Commits

Summary

As noted in D40594, the frem instruction corresponds to fmod() except that it can't set errno.

This revision is now accepted and ready to land.Nov 30 2017, 12:29 AM

This revision was automatically updated to reflect the committed changes.

Path

Size

llvm/

trunk/

docs/

10 lines

	Show First 20 Lines • Show All 6,821 Lines • ▼ Show 20 Lines

	The two arguments to the '``frem``' instruction must be :ref:`floating			The two arguments to the '``frem``' instruction must be :ref:`floating
	point <t_floating>` or :ref:`vector <t_vector>` of floating point values.			point <t_floating>` or :ref:`vector <t_vector>` of floating point values.
	Both arguments must have identical types.			Both arguments must have identical types.

	Semantics:			Semantics:
	""""""""""			""""""""""

	This instruction returns the remainder of a division. The remainder			Return the same value as a libm '``fmod``' function but without trapping or
	has the same sign as the dividend. This instruction can also take any			setting ``errno``.
	number of :ref:`fast-math flags <fastmath>`, which are optimization hints
	to enable otherwise unsafe floating point optimizations:			The remainder has the same sign as the dividend. This instruction can also
				take any number of :ref:`fast-math flags <fastmath>`, which are optimization
				hints to enable otherwise unsafe floating-point optimizations:

	Example:			Example:
	""""""""			""""""""

	.. code-block:: text			.. code-block:: text

	<result> = frem float 4.0, %var ; yields float:result = 4.0 % %var			<result> = frem float 4.0, %var ; yields float:result = 4.0 % %var

	▲ Show 20 Lines • Show All 7,697 Lines • Show Last 20 Lines