You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

154 lines
8.0KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1988-2020 Free Software Foundation, Inc.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with the
  7. Invariant Sections being "Funding Free Software", the Front-Cover
  8. Texts being (a) (see below), and with the Back-Cover Texts being (b)
  9. (see below). A copy of the license is included in the section entitled
  10. "GNU Free Documentation License".
  11. (a) The FSF's Front-Cover Text is:
  12. A GNU Manual
  13. (b) The FSF's Back-Cover Text is:
  14. You have freedom to copy and modify this GNU Manual, like GNU
  15. software. Copies published by the Free Software Foundation raise
  16. funds for GNU development. -->
  17. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
  18. <head>
  19. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  20. <title>Range checks on poly_ints (GNU Compiler Collection (GCC) Internals)</title>
  21. <meta name="description" content="Range checks on poly_ints (GNU Compiler Collection (GCC) Internals)">
  22. <meta name="keywords" content="Range checks on poly_ints (GNU Compiler Collection (GCC) Internals)">
  23. <meta name="resource-type" content="document">
  24. <meta name="distribution" content="global">
  25. <meta name="Generator" content="makeinfo">
  26. <link href="index.html#Top" rel="start" title="Top">
  27. <link href="Option-Index.html#Option-Index" rel="index" title="Option Index">
  28. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  29. <link href="Comparisons-involving-poly_005fint.html#Comparisons-involving-poly_005fint" rel="up" title="Comparisons involving poly_int">
  30. <link href="Sorting-poly_005fints.html#Sorting-poly_005fints" rel="next" title="Sorting poly_ints">
  31. <link href="Checking-for-a-poly_005fint-marker-value.html#Checking-for-a-poly_005fint-marker-value" rel="prev" title="Checking for a poly_int marker value">
  32. <style type="text/css">
  33. <!--
  34. a.summary-letter {text-decoration: none}
  35. blockquote.indentedblock {margin-right: 0em}
  36. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  37. blockquote.smallquotation {font-size: smaller}
  38. div.display {margin-left: 3.2em}
  39. div.example {margin-left: 3.2em}
  40. div.lisp {margin-left: 3.2em}
  41. div.smalldisplay {margin-left: 3.2em}
  42. div.smallexample {margin-left: 3.2em}
  43. div.smalllisp {margin-left: 3.2em}
  44. kbd {font-style: oblique}
  45. pre.display {font-family: inherit}
  46. pre.format {font-family: inherit}
  47. pre.menu-comment {font-family: serif}
  48. pre.menu-preformatted {font-family: serif}
  49. pre.smalldisplay {font-family: inherit; font-size: smaller}
  50. pre.smallexample {font-size: smaller}
  51. pre.smallformat {font-family: inherit; font-size: smaller}
  52. pre.smalllisp {font-size: smaller}
  53. span.nolinebreak {white-space: nowrap}
  54. span.roman {font-family: initial; font-weight: normal}
  55. span.sansserif {font-family: sans-serif; font-weight: normal}
  56. ul.no-bullet {list-style: none}
  57. -->
  58. </style>
  59. </head>
  60. <body lang="en">
  61. <a name="Range-checks-on-poly_005fints"></a>
  62. <div class="header">
  63. <p>
  64. Next: <a href="Sorting-poly_005fints.html#Sorting-poly_005fints" accesskey="n" rel="next">Sorting <code>poly_int</code>s</a>, Previous: <a href="Checking-for-a-poly_005fint-marker-value.html#Checking-for-a-poly_005fint-marker-value" accesskey="p" rel="prev">Checking for a <code>poly_int</code> marker value</a>, Up: <a href="Comparisons-involving-poly_005fint.html#Comparisons-involving-poly_005fint" accesskey="u" rel="up">Comparisons involving <code>poly_int</code></a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
  65. </div>
  66. <hr>
  67. <a name="Range-checks-on-poly_005fints-1"></a>
  68. <h4 class="subsection">10.3.6 Range checks on <code>poly_int</code>s</h4>
  69. <p>As well as the core comparisons
  70. (see <a href="Comparison-functions-for-poly_005fint.html#Comparison-functions-for-poly_005fint">Comparison functions for <code>poly_int</code></a>), <code>poly_int</code> provides
  71. utilities for various kinds of range check. In each case the range
  72. is represented by a start position and a size rather than a start
  73. position and an end position; this is because the former is used
  74. much more often than the latter in GCC. Also, the sizes can be
  75. -1 (or all ones for unsigned sizes) to indicate a range with a known
  76. start position but an unknown size. All other sizes must be nonnegative.
  77. A range of size 0 does not contain anything or overlap anything.
  78. </p>
  79. <dl compact="compact">
  80. <dt>&lsquo;<samp>known_size_p (<var>size</var>)</samp>&rsquo;</dt>
  81. <dd><p>Return true if <var>size</var> represents a known range size, false if it
  82. is -1 or all ones (for signed and unsigned types respectively).
  83. </p>
  84. </dd>
  85. <dt>&lsquo;<samp>ranges_maybe_overlap_p (<var>pos1</var>, <var>size1</var>, <var>pos2</var>, <var>size2</var>)</samp>&rsquo;</dt>
  86. <dd><p>Return true if the range described by <var>pos1</var> and <var>size1</var> <em>might</em>
  87. overlap the range described by <var>pos2</var> and <var>size2</var> (in other words,
  88. return true if we cannot prove that the ranges are disjoint).
  89. </p>
  90. </dd>
  91. <dt>&lsquo;<samp>ranges_known_overlap_p (<var>pos1</var>, <var>size1</var>, <var>pos2</var>, <var>size2</var>)</samp>&rsquo;</dt>
  92. <dd><p>Return true if the range described by <var>pos1</var> and <var>size1</var> is known to
  93. overlap the range described by <var>pos2</var> and <var>size2</var>.
  94. </p>
  95. </dd>
  96. <dt>&lsquo;<samp>known_subrange_p (<var>pos1</var>, <var>size1</var>, <var>pos2</var>, <var>size2</var>)</samp>&rsquo;</dt>
  97. <dd><p>Return true if the range described by <var>pos1</var> and <var>size1</var> is known to
  98. be contained in the range described by <var>pos2</var> and <var>size2</var>.
  99. </p>
  100. </dd>
  101. <dt>&lsquo;<samp>maybe_in_range_p (<var>value</var>, <var>pos</var>, <var>size</var>)</samp>&rsquo;</dt>
  102. <dd><p>Return true if <var>value</var> <em>might</em> be in the range described by
  103. <var>pos</var> and <var>size</var> (in other words, return true if we cannot
  104. prove that <var>value</var> is outside that range).
  105. </p>
  106. </dd>
  107. <dt>&lsquo;<samp>known_in_range_p (<var>value</var>, <var>pos</var>, <var>size</var>)</samp>&rsquo;</dt>
  108. <dd><p>Return true if <var>value</var> is known to be in the range described
  109. by <var>pos</var> and <var>size</var>.
  110. </p>
  111. </dd>
  112. <dt>&lsquo;<samp>endpoint_representable_p (<var>pos</var>, <var>size</var>)</samp>&rsquo;</dt>
  113. <dd><p>Return true if the range described by <var>pos</var> and <var>size</var> is
  114. open-ended or if the endpoint (<var>pos</var> + <var>size</var>) is representable
  115. in the same type as <var>pos</var> and <var>size</var>. The function returns false
  116. if adding <var>size</var> to <var>pos</var> makes conceptual sense but could overflow.
  117. </p></dd>
  118. </dl>
  119. <p>There is also a <code>poly_int</code> version of the <code>IN_RANGE_P</code> macro:
  120. </p>
  121. <dl compact="compact">
  122. <dt>&lsquo;<samp>coeffs_in_range_p (<var>x</var>, <var>lower</var>, <var>upper</var>)</samp>&rsquo;</dt>
  123. <dd><p>Return true if every coefficient of <var>x</var> is in the inclusive range
  124. [<var>lower</var>, <var>upper</var>]. This function can be useful when testing
  125. whether an operation would cause the values of coefficients to
  126. overflow.
  127. </p>
  128. <p>Note that the function does not indicate whether <var>x</var> itself is in the
  129. given range. <var>x</var> can be either a constant or a <code>poly_int</code>.
  130. </p></dd>
  131. </dl>
  132. <hr>
  133. <div class="header">
  134. <p>
  135. Next: <a href="Sorting-poly_005fints.html#Sorting-poly_005fints" accesskey="n" rel="next">Sorting <code>poly_int</code>s</a>, Previous: <a href="Checking-for-a-poly_005fint-marker-value.html#Checking-for-a-poly_005fint-marker-value" accesskey="p" rel="prev">Checking for a <code>poly_int</code> marker value</a>, Up: <a href="Comparisons-involving-poly_005fint.html#Comparisons-involving-poly_005fint" accesskey="u" rel="up">Comparisons involving <code>poly_int</code></a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
  136. </div>
  137. </body>
  138. </html>