Skip to content

Commit

Permalink
Added links to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@hosseinmoein
hosseinmoein committed Oct 31, 2024
1 parent 58d51f7 commit d49fcaa
Show file tree
Hide file tree
Showing 15 changed files with 33 additions and 33 deletions.
4 changes: 2 additions & 2 deletions docs/HTML/AutoCorrVisitor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,10 @@
</td>
<td>
This is a "single action visitor", meaning it is passed the whole data vector in one call and you must use the single_act_visit() interface.<BR><BR>
This functor class calculates the auto correlation of given column. The calculation lag is fixed with the given lag parameter. See <I>roll_policy</I> for how the calculations are done<BR>
This functor class calculates the auto correlation of given column. The calculation lag is fixed with the given lag parameter. See <I><a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/roll_policy.html">roll_policy</a></I> for how the calculations are done<BR>

<PRE><I>
FixedAutoCorrVisitor (size_type lag_period, roll_policy rp);
FixedAutoCorrVisitor (size_type lag_period, <a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/roll_policy.html">roll_policy</a> rp);

<B>lag_period</B>: Period to offset the correlation calculations
<B>rp</B>: How to roll over the input with the lagged period. See roll_policy
Expand Down
2 changes: 1 addition & 1 deletion docs/HTML/DataFrame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -622,7 +622,7 @@ <H2 ID="2"><font color="blue">API Reference with code samples <font size="+4">&#
</tr>

<tr class="item" onmouseover="this.style.backgroundColor='#ffff66';" onmouseout="this.style.backgroundColor='#d4e3e5';">
<td title="These are other functionalities of DataFrame" style="text-align:center;background-color:LightGrey;color:DarkBlue">Miscellaneous &nbsp;&nbsp; <font size="+3">&#x1F9A9;</font></td>
<td title="These are other functionalities of DataFrame" style="text-align:center;background-color:LightGrey;color:DarkBlue">Gears &nbsp;&nbsp; <font size="+3">&#x2699;</font></td>
</tr>

<tr class="item" onmouseover="this.style.backgroundColor='#ffff66';" onmouseout="this.style.backgroundColor='#d4e3e5';">
Expand Down
6 changes: 3 additions & 3 deletions docs/HTML/append_column.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
std::size_t
append_column(const char *name,
const T &amp;val,
nan_policy padding = nan_policy::pad_with_nans);
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/nan_policy.html" style="color:white">nan_policy</a> padding = nan_policy::pad_with_nans);
</B></PRE></font>
</td>
<td>
Expand All @@ -68,8 +68,8 @@
template&lt;typename ITR&gt;
std::size_t
append_column(const char *name,
Index2D&lt;const ITR &amp;&gt; range,
nan_policy padding = nan_policy::pad_with_nans);
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a>&lt;const ITR &amp;&gt; range,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/nan_policy.html" style="color:white">nan_policy</a> padding = nan_policy::pad_with_nans);
</B></PRE></font>
</td>
<td>
Expand Down
2 changes: 1 addition & 1 deletion docs/HTML/append_index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<PRE><B>
template&lt;typename ITR&gt;
std::size_t
append_index(Index2D<const ITR &> range);
append_index(<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a><const ITR &> range);
</B></PRE></font>
</td>
<td>
Expand Down
4 changes: 2 additions & 2 deletions docs/HTML/change_freq.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
template&lt;typename ... Ts&gt;
DataFrame&lt;T, H&gt;
change_freq(size_type new_freq,
time_frequency time_unit =
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/time_frequency.html" style="color:white">time_frequency</a> time_unit =
time_frequency::not_valid) const;
</B></PRE></font>
</td>
Expand All @@ -59,7 +59,7 @@
<td width="35%">
<B>Ts</B>: List all the types of all data columns. A type should be specified in the list only once.<BR>
<B>new_freq</B>: The new frequency expressed in a positive integer value. The Unit depends on the index type and <I>time_unit</I> parameter<BR>
<B>time_unit</B>: Time unit based on <I>time_frequency</I> enum. If index time is not <I>DateTime</I>, <I>time_unit</I> must be <I>not_valid</I>. If index time is <I>DateTime</I>, <I>time_unit</I> must not be <I>not_valid</I>. Otherwise, the behavior is undefined.<BR>
<B>time_unit</B>: Time unit based on <I><a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/time_frequency.html">time_frequency</a></I> enum. If index time is not <I>DateTime</I>, <I>time_unit</I> must be <I>not_valid</I>. If index time is <I>DateTime</I>, <I>time_unit</I> must not be <I>not_valid</I>. Otherwise, the behavior is undefined.<BR>
</td>
</tr>

Expand Down
2 changes: 1 addition & 1 deletion docs/HTML/gen_datetime_index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
static std::vector&lt;typename I&gt;
gen_datetime_index(const char *start_datetime,
const char *end_datetime,
time_frequency t_freq,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/time_frequency.html" style="color:white">time_frequency</a> t_freq,
long increment = 1,
DT_TIME_ZONE tz = DT_TIME_ZONE::LOCAL);
</B></PRE></font>
Expand Down
6 changes: 3 additions & 3 deletions docs/HTML/get_data_by_idx.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<PRE><B>
template&lt;typename ... Ts&gt;
DataFrame
get_data_by_idx(Index2D&lt;IndexType&gt; range) const;
get_data_by_idx(<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a>&lt;IndexType&gt; range) const;
</B></PRE></font>
</td>
<td>
Expand Down Expand Up @@ -82,7 +82,7 @@
<PRE><B>
template&lt;typename ... Ts&gt;
View
get_view_by_idx(Index2D&lt;IndexType&gt; range);
get_view_by_idx(<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a>&lt;IndexType&gt; range);
</B></PRE></font>
</td>
<td>
Expand Down Expand Up @@ -121,7 +121,7 @@
<PRE><B>
template&lt;typename ... Ts&gt;
ConstView
get_view_by_idx(Index2D&lt;IndexType&gt; range) const;
get_view_by_idx(<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a>&lt;IndexType&gt; range) const;
</B></PRE></font>
</td>
<td>
Expand Down
6 changes: 3 additions & 3 deletions docs/HTML/get_data_by_loc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<PRE><B>
template&lt;typename ... Ts&gt;
DataFrame&lt;I, H&gt;
get_data_by_loc(Index2D&lt;long&gt; range) const;
get_data_by_loc(<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a>&lt;long&gt; range) const;
</B></PRE></font>
</td>
<td>
Expand Down Expand Up @@ -84,7 +84,7 @@
<PRE><B>
template&lt;typename ... Ts&gt;
View
get_view_by_loc(Index2D&lt;long&gt; range);
get_view_by_loc(<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a>&lt;long&gt; range);
</B></PRE></font>
</td>
<td>
Expand Down Expand Up @@ -123,7 +123,7 @@
<PRE><B>
template&lt;typename ... Ts&gt;
ConstView
get_view_by_loc(Index2D&lt;long&gt; range) const;
get_view_by_loc(<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a>&lt;long&gt; range) const;
</B></PRE></font>
</td>
<td>
Expand Down
2 changes: 1 addition & 1 deletion docs/HTML/load_column.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
template&lt;typename T, typename ITR&gt;
std::size_t
load_column(const char *name,
Index2D&lt;const ITR &amp;&gt; range,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a>&lt;const ITR &amp;&gt; range,
nan_policy padding = nan_policy::pad_with_nans,
bool do_lock = true);
</B></PRE></font>
Expand Down
10 changes: 5 additions & 5 deletions docs/HTML/load_result_as_column.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
std::size_t
load_result_as_column(V &amp;visitor,
const char *new_col_name,
nan_policy padding = nan_policy::pad_with_nans);
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/nan_policy.html" style="color:white">nan_policy</a> padding = nan_policy::pad_with_nans);
</B></PRE></font>
</td>
<td>
Expand Down Expand Up @@ -79,7 +79,7 @@
load_result_as_column(const char *col_name,
V &amp;&amp;visitor,
const char *new_col_name,
nan_policy padding = nan_policy::pad_with_nans);
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/nan_policy.html" style="color:white">nan_policy</a> padding = nan_policy::pad_with_nans);
</B></PRE></font>
</td>
<td>
Expand Down Expand Up @@ -110,7 +110,7 @@
const char *col_name2,
V &amp;&amp;visitor,
const char *new_col_name,
nan_policy padding = nan_policy::pad_with_nans);
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/nan_policy.html" style="color:white">nan_policy</a> padding = nan_policy::pad_with_nans);
</B></PRE></font>
</td>
<td>
Expand Down Expand Up @@ -138,7 +138,7 @@
const char *col_name3,
V &amp;&amp;visitor,
const char *new_col_name,
nan_policy padding = nan_policy::pad_with_nans);
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/nan_policy.html" style="color:white">nan_policy</a> padding = nan_policy::pad_with_nans);
</B></PRE></font>
</td>
<td>
Expand Down Expand Up @@ -169,7 +169,7 @@
const char *col_name4,
V &amp;&amp;visitor,
const char *new_col_name,
nan_policy padding = nan_policy::pad_with_nans);
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/nan_policy.html" style="color:white">nan_policy</a> padding = nan_policy::pad_with_nans);
</B></PRE></font>
</td>
<td>
Expand Down
2 changes: 1 addition & 1 deletion docs/HTML/modify_by_idx.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
template&lt;typename ... Ts&gt;
DataFrame &amp;
modify_by_idx(DataFrame &amp;rhs,
sort_state already_sorted = sort_state::not_sorted);
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/sort_state.html" style="color:white">sort_state</a> already_sorted = sort_state::not_sorted);
</B></PRE></font>
</td>
<td>
Expand Down
8 changes: 4 additions & 4 deletions docs/HTML/read.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<PRE><B>
bool
read(const char *file_name,
io_format iof = io_format::csv,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/io_format.html" style="color:white">io_format</a> iof = io_format::csv,
bool columns_only = false,
size_t starting_row = 0,
size_t num_rows = std::numeric_limits&lt;size_t&gt;::max());
Expand Down Expand Up @@ -193,7 +193,7 @@
template&lt;typename S&gt;
bool
read(S &amp;in_s,
io_format iof = io_format::csv,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/io_format.html" style="color:white">io_format</a> iof = io_format::csv,
bool columns_only = false);
</B></PRE></font>
</td>
Expand All @@ -209,7 +209,7 @@
<PRE><B>
std::future&lt;bool&gt;
read_async(const char *file_name,
io_format iof = io_format::csv,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/io_format.html" style="color:white">io_format</a> iof = io_format::csv,
bool columns_only = false);
</B></PRE></font>
</td>
Expand All @@ -226,7 +226,7 @@
template&lt;typename S&gt;
std::future&lt;bool&gt;
read_async(S &amp;in_s,
io_format iof = io_format::csv,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/io_format.html" style="color:white">io_format</a> iof = io_format::csv,
bool columns_only = false);
</B></PRE></font>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/HTML/remove_data_by_idx.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<PRE><B>
template&lt;typename ... Ts&gt;
void
remove_data_by_idx(Index2D&lt;I&gt; range);
remove_data_by_idx(<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a>&lt;I&gt; range);
</B></PRE></font>
</td>
<td width = "33.3%">
Expand Down
2 changes: 1 addition & 1 deletion docs/HTML/remove_data_by_loc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<PRE><B>
template&lt;typename ... Ts&gt;
void
remove_data_by_loc(Index2D&lt;I&gt; range);
remove_data_by_loc(<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/Index2D.html" style="color:white">Index2D</a>&lt;I&gt; range);
</B></PRE></font>
</td>
<td width = "33.3%">
Expand Down
8 changes: 4 additions & 4 deletions docs/HTML/write.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
template&lt;typename S, typename ... Ts&gt;
bool
write(S &amp;o,
io_format iof = io_format::csv,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/io_format.html" style="color:white">io_format</a> iof = io_format::csv,
std::streamsize precision = 12,
bool columns_only = false,
long max_recs = std::numeric_limits<long>::max()) const; </font>
Expand Down Expand Up @@ -191,7 +191,7 @@
template&lt;typename ... Ts&gt;
std::future&lt;bool&gt;
write(const char *file_name,
io_format iof = io_format::csv,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/io_format.html" style="color:white">io_format</a> iof = io_format::csv,
std::streamsize precision = 12,
bool columns_only = false,
long max_recs = std::numeric_limits<long>::max()) const; </font>
Expand All @@ -211,7 +211,7 @@
template&lt;typename S, typename ... Ts&gt;
std::future&lt;bool&gt;
write_async(S &amp;o,
io_format iof = io_format::csv,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/io_format.html" style="color:white">io_format</a> iof = io_format::csv,
std::streamsize precision = 12,
bool columns_only = false,
long max_recs = std::numeric_limits<long>::max()) const; </font>
Expand All @@ -230,7 +230,7 @@
template&lt;typename ... Ts&gt;
std::future&lt;bool&gt;
write_async(const char *file_name,
io_format iof = io_format::csv,
<a href="https://htmlpreview.github.io/?https://github.com/hosseinmoein/DataFrame/blob/master/docs/HTML/io_format.html" style="color:white">io_format</a> iof = io_format::csv,
std::streamsize precision = 12,
bool columns_only = false,
long max_recs = std::numeric_limits<long>::max()) const; </font>
Expand Down

0 comments on commit d49fcaa

Please sign in to comment.