RONCC
/
HPC-Tools-for-Quantum-Computing


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
							<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="generator" content="rustdoc">
    <meta name="description" content="API documentation for the Rust `util` mod in crate `ocl_core`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, util">

    <title>ocl_core::util - Rust</title>

    <link rel="stylesheet" type="text/css" href="../../normalize.css">
    <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
    
    <link rel="stylesheet" type="text/css" href="../../dark.css">
    <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
    <script src="../../storage.js"></script>
    

    
    
</head>
<body class="rustdoc mod">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        <div class="sidebar-menu">&#9776;</div>
        
        <p class='location'>Module util</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>ocl_core</a></p><script>window.sidebarCurrent = {name: 'util', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div>
    </nav>

    <div class="theme-picker">
        <button id="theme-picker" aria-label="Pick another theme!">
            <img src="../../brush.svg" width="18" alt="Pick another theme!">
        </button>
        <div id="theme-choices"></div>
    </div>
    <script src="../../theme.js"></script>
    <nav class="sub">
        <form class="search-form js-only">
            <div class="search-container">
                <input class="search-input" name="search"
                       autocomplete="off"
                       placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
                       type="search">
            </div>
        </form>
    </nav>

    <section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>ocl_core</a>::<wbr><a class="mod" href=''>util</a></span><span class='out-of-band'><span id='render-detail'>
                   <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                       [<span class='inner'>&#x2212;</span>]
                   </a>
               </span><a class='srclink' href='../../src/ocl_core/util.rs.html#1-531' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Utility and debugging functions.</p>
<h2 id="stability" class="section-header"><a href="#stability">Stability</a></h2>
<p>Printing functions may be moved/renamed/removed at any time.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="mod" href="colors/index.html"
                                  title='mod ocl_core::util::colors'>colors</a></td>
                           <td class='docblock-short'>
                                <p>ASCII Color Palette</p>

                           </td>
                       </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="enum" href="enum.UtilError.html"
                                  title='enum ocl_core::util::UtilError'>UtilError</a></td>
                           <td class='docblock-short'>
                                <p>An error caused by a utility function.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="enum" href="enum.VecRemoveRebuildError.html"
                                  title='enum ocl_core::util::VecRemoveRebuildError'>VecRemoveRebuildError</a></td>
                           <td class='docblock-short'>
                                <p>An error caused by <code>util::vec_remove_rebuild</code>.</p>

                           </td>
                       </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.bytes_into.html"
                                  title='fn ocl_core::util::bytes_into'>bytes_into</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
                           <td class='docblock-short'>
                                <p>Converts a vector of bytes into a value of arbitrary type.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.bytes_into_string.html"
                                  title='fn ocl_core::util::bytes_into_string'>bytes_into_string</a></td>
                           <td class='docblock-short'>
                                <p>Converts a byte Vec into a string, removing the trailing null byte if it
exists.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.bytes_into_vec.html"
                                  title='fn ocl_core::util::bytes_into_vec'>bytes_into_vec</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
                           <td class='docblock-short'>
                                <p>Converts a vector of bytes into a vector of arbitrary type.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.bytes_to.html"
                                  title='fn ocl_core::util::bytes_to'>bytes_to</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
                           <td class='docblock-short'>
                                <p>Copies a slice of bytes to a new value of arbitrary type.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.bytes_to_u32.html"
                                  title='fn ocl_core::util::bytes_to_u32'>bytes_to_u32</a></td>
                           <td class='docblock-short'>
                                <p>Copies a byte slice to a new <code>u32</code>.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.bytes_to_vec.html"
                                  title='fn ocl_core::util::bytes_to_vec'>bytes_to_vec</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
                           <td class='docblock-short'>
                                <p>Copies a slice of bytes into a vector of arbitrary type.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.into_bytes.html"
                                  title='fn ocl_core::util::into_bytes'>into_bytes</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
                           <td class='docblock-short'>
                                <p>[UNTESTED] Copies an arbitrary primitive or struct into core bytes.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.padded_len.html"
                                  title='fn ocl_core::util::padded_len'>padded_len</a></td>
                           <td class='docblock-short'>
                                <p>Pads <code>len</code> to make it evenly divisible by <code>incr</code>.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.print_bytes_as_hex.html"
                                  title='fn ocl_core::util::print_bytes_as_hex'>print_bytes_as_hex</a></td>
                           <td class='docblock-short'>
                                <p>Prints bytes as hex.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.print_simple.html"
                                  title='fn ocl_core::util::print_simple'>print_simple</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.print_slice.html"
                                  title='fn ocl_core::util::print_slice'>print_slice</a></td>
                           <td class='docblock-short'>
                                <p>[UNSTABLE]: MAY BE REMOVED AT ANY TIME
Prints a vector to stdout. Used for debugging.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.print_val_range.html"
                                  title='fn ocl_core::util::print_val_range'>print_val_range</a></td>
                           <td class='docblock-short'>
                                
                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.vec_remove_rebuild.html"
                                  title='fn ocl_core::util::vec_remove_rebuild'>vec_remove_rebuild</a></td>
                           <td class='docblock-short'>
                                <p>Batch removes elements from a vector using a list of indices to remove.</p>

                           </td>
                       </tr>
                       <tr class=' module-item'>
                           <td><a class="fn" href="fn.wrap_vals.html"
                                  title='fn ocl_core::util::wrap_vals'>wrap_vals</a></td>
                           <td class='docblock-short'>
                                <p>Wraps (<code>%</code>) each value in the list <code>vals</code> if it equals or exceeds <code>val_n</code>.</p>

                           </td>
                       </tr></table></section>
    <section id='search' class="content hidden"></section>

    <section class="footer"></section>

    <aside id="help" class="hidden">
        <div>
            <h1 class="hidden">Help</h1>

            <div class="shortcuts">
                <h2>Keyboard Shortcuts</h2>

                <dl>
                    <dt><kbd>?</kbd></dt>
                    <dd>Show this help dialog</dd>
                    <dt><kbd>S</kbd></dt>
                    <dd>Focus the search field</dd>
                    <dt><kbd>↑</kbd></dt>
                    <dd>Move up in search results</dd>
                    <dt><kbd>↓</kbd></dt>
                    <dd>Move down in search results</dd>
                    <dt><kbd>↹</kbd></dt>
                    <dd>Switch tab</dd>
                    <dt><kbd>&#9166;</kbd></dt>
                    <dd>Go to active search result</dd>
                    <dt><kbd>+</kbd></dt>
                    <dd>Expand all sections</dd>
                    <dt><kbd>-</kbd></dt>
                    <dd>Collapse all sections</dd>
                </dl>
            </div>

            <div class="infos">
                <h2>Search Tricks</h2>

                <p>
                    Prefix searches with a type followed by a colon (e.g.
                    <code>fn:</code>) to restrict the search to a given type.
                </p>

                <p>
                    Accepted types are: <code>fn</code>, <code>mod</code>,
                    <code>struct</code>, <code>enum</code>,
                    <code>trait</code>, <code>type</code>, <code>macro</code>,
                    and <code>const</code>.
                </p>

                <p>
                    Search functions by type signature (e.g.
                    <code>vec -> usize</code> or <code>* -> vec</code>)
                </p>
            </div>
        </div>
    </aside>

    

    <script>
        window.rootPath = "../../";
        window.currentCrate = "ocl_core";
    </script>
    <script src="../../main.js"></script>
    <script defer src="../../search-index.js"></script>
</body>
</html>