CodenameEngine/pages/funkin/backend/utils/SortedArrayUtil.html

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../../jquery-1.9.1.min.js"></script><script src="../../../bootstrap/js/bootstrap.min.js"></script><script src="../../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../../styles.css" rel="stylesheet"/><link href="../../../extra-styles.css" rel="stylesheet"/><link href="../../../haxe-nav.css" rel="stylesheet"/><link href="../../../dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "../../../",platforms: ["doc"]};</script><script src="../../../nav.js"></script><script src="../../../index.js"></script><link rel="icon" href="../../../favicon.ico" type="image/x-icon"/><title>funkin.backend.utils.SortedArrayUtil</title><meta name="description" content="All types of utils only usable in a sorted array."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
	display: inline-block;
	float: none;
	text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../../../">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> SortedArrayUtil</h1><h4><small>package <a href="../../../funkin/backend/utils/index.html">funkin.backend.utils</a></small></h4>    <span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(hscript.ClassExtendMacro.build())</span></div><div class="body"><div class="doc doc-main"><p>All types of utils only usable in a sorted array.</p></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="addSorted"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#addSorted"><span class="identifier">addSorted</span></a>&lt;<span class="type">T</span>&gt;(<span style="white-space:nowrap">array:<span class="type">Array</span>&lt;<span class="type">T</span>&gt;,</span> <span style="white-space:nowrap">val:<span class="type">T</span>,</span> <span style="white-space:nowrap">getVal:<span class="type">T</span>&nbsp;&#8209;&gt;&nbsp;<span class="type">Float</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Adds to a sorted array, using binary search.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>array</code></th><td><p>Array to add to</p></td></tr><tr><th style="width:25%;"><code>val</code></th><td><p>Value to add</p></td></tr><tr><th style="width:25%;"><code>getVal</code></th><td><p>Function that returns the value that needs to be sorted</p></td></tr></table></div></div><div class="field "><a name="binarySearch"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#binarySearch"><span class="identifier">binarySearch</span></a>&lt;<span class="type">T</span>&gt;(<span style="white-space:nowrap">array:<span class="type">Array</span>&lt;<span class="type">T</span>&gt;,</span> <span style="white-space:nowrap">val:<span class="type">Float</span>,</span> <span style="white-space:nowrap">getVal:<span class="type">T</span>&nbsp;&#8209;&gt;&nbsp;<span class="type">Float</span></span>):<span class="type">Int</span></code></h3><div class="doc"><p>Gets the index of a possible new element of an Array of T using an efficient algorithm.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>array</code></th><td><p>Array of T to check in</p></td></tr><tr><th style="width:25%;"><code>getVal</code></th><td><p>Function that returns the position value of T</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Index</p></div></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">&copy; 2023 &nbsp;</p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>