Skip to content

Commit fcdf0c8

Browse files
ArnoldMSUArnoldMSU
committed
update docs
1 parent 8a58c6d commit fcdf0c8

7 files changed

Lines changed: 47 additions & 10 deletions

File tree

‎docs/doc_index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ <h4> <font color=#e2e6ee> Table of contents: </font> </h4>
487487

488488
<p></div>
489489
<center> <h1>RedBlackPy </h1> </center>
490-
<center> <h4>Fast high level trees wrappers for data processing in Python </h4> </center></p>
490+
<center> <h4>Fast and scalable data structures for scientific and quantitative research in Python </h4> </center></p>
491491

492492
<p>RedBlackPy is a light Python library that provides data structures aimed to fast insertion, removal and self sorting to manipulating ordered data in efficient way. The core part of the library had been written on C++ and then was wrapped in <a href="http://cython.org">Cython</a>. Hope that many would find the primary data structures of this library very handy in working with time series. One of the main feature of this structures is an access by arbitrary key using interpolation, what makes processing of multiple non synchronized time series very simple. All data structures based on red black trees.</p>
493493

‎docs/favicon.png‎

-676 Bytes
Binary file not shown.

‎docs/icon.png‎

15.2 KB
Loading

‎docs/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<link rel="apple-touch-icon" sizes="72x72" href="apple-touch-icon-ipad.png" />
1111
<link rel="apple-touch-icon" sizes="114x114" href="apple-touch-icon-iphone-retina.png" />
1212
<link rel="apple-touch-icon" sizes="144x144" href="apple-touch-icon-ipad-retina.png" />
13-
<link rel="shortcut icon" type="image/png" href="favicon.png" />
13+
<link rel="shortcut icon" type="image/png" href="icon.png" />
1414

1515
<link href='http://fonts.googleapis.com/css?family=PT+Sans:400,700|PT+Serif:400,700&subset=latin,cyrillic-ext' rel='stylesheet' type='text/css'>
1616
<link rel="stylesheet" href="node_modules/video.js/dist/video-js.min.css" media="all" />
@@ -30,7 +30,7 @@
3030
</div>
3131
<div class="wrapper__body">
3232
<div class="wrapper__info">
33-
<h1>RedBlackPy v1.2</h1>
33+
<h1>RedBlackPy v0.1.0</h1>
3434
<div class="main-info">
3535
<p>Fast and scalable data structures for dynamic ordered data processing.</p>
3636
<p>RedBlackPy is a Python library built on red-black trees instead of hash-tables and arrays for convenient work with time series and scientific evaluations.</p>

‎docs/series.html‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -760,10 +760,6 @@ <h2 id="toc_4">Methods</h2>
760760
<td>linear interpolation between two keys.</td>
761761
</tr>
762762
<tr>
763-
<td><code>&quot;const&quot;</code></td>
764-
<td>returns constant that set by user.</td>
765-
</tr>
766-
<tr>
767763
<td><code>&quot;error&quot;</code></td>
768764
<td>returns KeyError, getitem works only for keys in index.</td>
769765
</tr>

‎docs/series_user_guide.html‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@
475475
<body>
476476

477477
<div id="toc_container" style="position:fixed;width: 200px;left:1em;top:1em">
478-
<h3> <font color=#e2e6ee> RedBlackPy </font> </h3>
478+
<h3> <font color=#e2e6ee> RedBlackPy 0.1.0 </font> </h3>
479479
<h4> <font color=#e2e6ee> Table of contents: </font> </h4>
480480
<div id="expanded" style="display: true">
481481
<a href="./doc_index.html" class="button">Main</a> <br>
@@ -547,6 +547,47 @@ <h2 id="toc_2">Interpolation</h2>
547547

548548
</code></pre></div>
549549

550+
<h2 id="toc_3">SeriesIterator</h2>
551+
552+
<div><pre><code class="language-python">import redblackpy as rb
553+
import random
554+
555+
def create_random_series(length):
556+
557+
data = random.sample(range(5000000), length)
558+
# with no loss of generality using one list for index and values
559+
return rb.Series(index=data, values=data, dtype=&#39;int64&#39;)
560+
561+
562+
#------------------------------------------------------------------------
563+
# create timer for executing time evaluation
564+
timer = rb.Timer()
565+
566+
# create list of 10 Series, each contains 100k values
567+
series_list = [ create_random_series(100000) for i in range(10) ]
568+
569+
# start time evaluation, we including initialization of SeriesIterator
570+
timer.start()
571+
iterator = rb.SeriesIterator(series_list)
572+
# iterating over union of ten Series
573+
for key in iterator():
574+
key
575+
# stop timer
576+
time_forward = timer.stop()
577+
578+
# the same procedure, but for reverse iterator
579+
timer.start()
580+
# iterating over union of ten Series
581+
for key in iterator(&#39;reverse&#39;):
582+
key
583+
# stop timer
584+
time_reverse = timer.stop()
585+
# obtain the results
586+
output_str = &#39;Time forward: {:}; Time reverse: {:}&#39;.format( time_forward,
587+
time_reverse )
588+
print(output_str)
589+
</code></pre></div>
590+
550591

551592

552593
<script type="text/javascript">

‎setup.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,8 @@
105105
maintainer_email='dev@intuition.engineering',
106106
install_requires=['cython>=0.27', 'pandas'],
107107
description='Series on red-black trees.',
108-
url='Intuition project site',
109-
download_url='https://github.com/IntuitionEngineeringTeam/RedBlackPy',
108+
url='https://intuitionengineeringteam.github.io/RedBlackPy/',
109+
download_url='https://github.com/IntuitionEngineeringTeam/RedBlackPy/archive/master.zip',
110110
zip_safe=False,
111111
packages=['redblackpy', 'redblackpy.series', 'redblackpy.benchmark'],
112112
package_data={'redblackpy.series': ['*.pxd']},

0 commit comments

Comments
 (0)