Skip to content

Commit 288d7c7

Browse files
committed
Docs
1 parent 88fc395 commit 288d7c7

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

docs/HTML/DataFrame.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2418,7 +2418,8 @@ <H4>2. DataFrame Internal Multithreading</H4>
24182418

24192419
<H2 ID="4"><font color="blue">Views <font size="+4">&#128269;</font></font></H2>
24202420
<P>
2421-
Views have useful and practical use-cases. A view is a slice of a DataFrame that is a reference to the original DataFrame. It appears exactly the same as a DataFrame, but if you modify any data in the view, the corresponding data point(s) in the original DataFrame will also be modified and vice versa. There are certain things you cannot do in views. For example, you cannot add or delete columns, extend the index column, ...<BR><BR>
2421+
Views have useful and practical use-cases. A view is a slice of a DataFrame that is a reference to the original DataFrame. It appears exactly the same as a DataFrame, but if you modify any data in the view, the corresponding data point(s) in the original DataFrame will also be modified and vice versa. Conceptually, views are very similar to <I>std::span</I> or <I>std::mdspan</I> in C++. If the original DataFrame goes out of scope, access to all its views will be UB.<BR>
2422+
There are certain things you cannot do in views. For example, you cannot add or delete columns, extend the index column, ...<BR><BR>
24222423

24232424
In general there are two kinds of views
24242425
<OL>

docs/HTML/PolyFitVisitor.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ <h1></h1>
104104
</td>
105105
<td>
106106
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>
107+
107108
This functor fits a <I>y = b<sub>0</sub> + b<sub>1</sub> * log(x)</I> through the given x-y coordinates by the way of calling PolyFit above on log(x).<BR><BR>
108109

109110
This works with both scalar and multidimensional (i.e. vectors or arrays) datasets.<BR><BR>
@@ -121,6 +122,7 @@ <h1></h1>
121122
weight_func w_func = [](const I &, size_t) -> data_t { return (1); });
122123
</PRE>
123124
</I>
125+
<B>degree</B>: The polynomial degree<BR>
124126
<B>w_func</B>: A functor that provides weights to be applied to sigma values. w_func is passed two parameters: (1) The value of the index column corresponding to the given y value, (2) The corresponding index into the y vector. The default is no weights.
125127
</td>
126128
<td width="30%">

0 commit comments

Comments
 (0)