UNPKG

cstd

Version:

CoffeeScript Standart Library

499 lines (497 loc) 12.4 kB
<!DOCTYPE html> <html> <head> <meta charset='UTF-8'> <title>CoffeeScript standarts</title> <script src='../javascript/application.js'></script> <script src='../javascript/search.js'></script> <link rel='stylesheet' href='../stylesheets/application.css' type='text/css'> </head> <body> <div id='base' data-path='../'></div> <div id='header'> <div id='menu'> <a href='../extra/README.md.html' title='CSTD'> CSTD </a> &raquo; <a href='../alphabetical_index.html' title='Index'> Index </a> &raquo; <span class='title'>NodeQueue</span> </div> </div> <div id='content'> <h1> Class: NodeQueue </h1> <table class='box'> <tr> <td>Defined in:</td> <td>lib&#47;cache&#47;node_queue.coffee</td> </tr> <tr> <td>Inherits:</td> <td> <a href='../class/CSObject.html'>CSObject</a> </td> </tr> </table> <h2>Overview</h2> <div class='docstring'> <p>fast-forced class of Queue for caches В основном для внутреннего использования: нет проверок на аргументы и есть функции смещения узлов к началу или к концу, при чём причастность узлов не проверяется. Так же начало и конец очереди публичные свойства</p> </div> <div class='tags'> </div> <h2>Property Summary</h2> <dl class='properties'> <dt id='front-property'> <span class='signature'> (Node) <b> front </b> </span> </dt> <dd class='desc'> верх стопки для взятия O(1) </dd> <dt id='back-property'> <span class='signature'> (Node) <b> back </b> </span> </dt> <dd class='desc'> конец очереди для добавления O(1) </dd> <dt id='length-property'> <span class='signature'> (number) <b> length </b> </span> </dt> <dd class='desc'> длина очереди </dd> </dl> <h2>Instance Method Summary</h2> <ul class='summary'> <li> <span class='signature'> <a href='#push-dynamic'> # (NodeQueue) <b>push</b><span>(some)</span> </a> </span> <span class='desc'> Добавление <em>одного</em> элемента <code>some</code> в очередь (возвращает очередь). </span> </li> <li> <span class='signature'> <a href='#pop-dynamic'> # (*) <b>pop</b><span>()</span> </a> </span> <span class='desc'> Получение и изъятие первого элемента из очереди, не принимает аргументов </span> </li> <li> <span class='signature'> <a href='#rise-dynamic'> # (NodeQueue) <b>rise</b><span>(node)</span> </a> </span> <span class='desc'> Перемещает элемент к началу очереди, если кто-то, допустим, заждался </span> </li> <li> <span class='signature'> <a href='#drop-dynamic'> # (NodeQueue) <b>drop</b><span>(node)</span> </a> </span> <span class='desc'> Перемещает элемент к концу очереди, если кто-то, допустим, хорошо держится </span> </li> <li> <span class='signature'> <a href='#remove-dynamic'> # (NodeQueue) <b>remove</b><span>(node)</span> </a> </span> <span class='desc'> Отвязывает узел от очереди грамотно, не уничтожая сам узел, а только очищая ссылки на соседние узлы </span> </li> <li> <span class='signature'> <a href='#clear-dynamic'> # (NodeQueue) <b>clear</b><span>()</span> </a> </span> <span class='desc'> Очищает очередь ото всех узлов. </span> </li> <li> <span class='signature'> <a href='#destructor-dynamic'> # (null) <b>destructor</b><span>()</span> </a> </span> <span class='desc'> Разрушает очередь, очищая её и все ссылки внутри неё </span> </li> </ul> <h2> <small>Inherited Method Summary</small> <h3 class='inherited'> Methods inherited from <a href='../class/CSObject.html'>CSObject</a> </h3> <p class='inherited'> <a href='../class/CSObject.html#destructor-dynamic'>#destructor</a> </p> </h2> <h2>Constructor Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='constructor-dynamic'> # (void) <b>constructor</b><span>()</span> <br> </p> <div class='docstring'> <p>Конструктор очереди просто собирает её, не принимая аргументов Работает без проверок</p> </div> <div class='tags'> </div> </div> </div> <h2>Instance Method Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='push-dynamic'> # (NodeQueue) <b>push</b><span>(some)</span> <br> </p> <div class='docstring'> <p>Добавление <em>одного</em> элемента <code>some</code> в очередь (возвращает очередь). Работает без проверок</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>some</span> <span class='type'> ( <tt>*</tt> ) </span> &mdash; <span class='desc'>добавляемая в конец сущность </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt><a href='../class/NodeQueue.html'>NodeQueue</a></tt> ) &mdash; <span class='desc'><code>this</code> </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='pop-dynamic'> # (*) <b>pop</b><span>()</span> <br> </p> <div class='docstring'> <p>Получение и изъятие первого элемента из очереди, не принимает аргументов</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>*</tt> ) &mdash; <span class='desc'>значение взятое с самого начала </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='rise-dynamic'> # (NodeQueue) <b>rise</b><span>(node)</span> <br> </p> <div class='docstring'> <p>Перемещает элемент к началу очереди, если кто-то, допустим, заждался</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>node</span> <span class='type'> ( <tt><a href='../class/Node.html'>Node</a></tt> ) </span> &mdash; <span class='desc'>узел из очереди. , Если он не из очереди, то поведение не предопределено </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt><a href='../class/NodeQueue.html'>NodeQueue</a></tt> ) &mdash; <span class='desc'><code>this</code> </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='drop-dynamic'> # (NodeQueue) <b>drop</b><span>(node)</span> <br> </p> <div class='docstring'> <p>Перемещает элемент к концу очереди, если кто-то, допустим, хорошо держится</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>node</span> <span class='type'> ( <tt><a href='../class/Node.html'>Node</a></tt> ) </span> &mdash; <span class='desc'>узел из очереди. , Если он не из очереди, то поведение не предопределено </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt><a href='../class/NodeQueue.html'>NodeQueue</a></tt> ) &mdash; <span class='desc'><code>this</code> </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='remove-dynamic'> # (NodeQueue) <b>remove</b><span>(node)</span> <br> </p> <div class='docstring'> <p>Отвязывает узел от очереди грамотно, не уничтожая сам узел, а только очищая ссылки на соседние узлы</p> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>node</span> <span class='type'> ( <tt><a href='../class/Node.html'>Node</a></tt> ) </span> &mdash; <span class='desc'>узел из списка, который удаляем </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt><a href='../class/NodeQueue.html'>NodeQueue</a></tt> ) &mdash; <span class='desc'><code>this</code> </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='clear-dynamic'> # (NodeQueue) <b>clear</b><span>()</span> <br> </p> <div class='docstring'> <p>Очищает очередь ото всех узлов. И не принимает аргументов</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt><a href='../class/NodeQueue.html'>NodeQueue</a></tt> ) &mdash; <span class='desc'><code>this</code> </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='destructor-dynamic'> # (null) <b>destructor</b><span>()</span> <br> </p> <div class='docstring'> <p>Разрушает очередь, очищая её и все ссылки внутри неё</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> <tt>null</tt> </li> </ul> </div> </div> </div> </div> <div id='footer'> By <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'> Codo </a> 2.1.0 &#10034; Press H to see the keyboard shortcuts &#10034; <a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a> &#10034; <a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a> </div> <iframe id='search_frame'></iframe> <div id='fuzzySearch'> <input type='text'> <ol></ol> </div> <div id='help'> <p> Quickly fuzzy find classes, mixins, methods, file: </p> <ul> <li> <span>T</span> Open fuzzy finder dialog </li> </ul> <p> Control the navigation frame: </p> <ul> <li> <span>L</span> Toggle list view </li> <li> <span>C</span> Show class list </li> <li> <span>I</span> Show mixin list </li> <li> <span>F</span> Show file list </li> <li> <span>M</span> Show method list </li> <li> <span>E</span> Show extras list </li> </ul> <p> You can focus and blur the search input: </p> <ul> <li> <span>S</span> Focus search input </li> <li> <span>Esc</span> Blur search input </li> </ul> </div> </body> </html>