-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: updated the docstring of Series.dot #22890
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 6 commits
0b5be6b
b05ab98
7ff5839
bc66d21
75c6d74
aa929a5
2895f94
14432a5
887d72d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2080,16 +2080,51 @@ def autocorr(self, lag=1): | |
|
||
def dot(self, other): | ||
""" | ||
Matrix multiplication with DataFrame or inner-product with Series | ||
objects. Can also be called using `self @ other` in Python >= 3.5. | ||
Compute the dot product between the Series and the columns of other. | ||
|
||
This method computes the dot product between the Series and another | ||
one, or the Series and each columns of a DataFrame, or the Series and | ||
each columns of an array. | ||
|
||
It can also be called using `self @ other` in Python >= 3.5. | ||
|
||
Parameters | ||
---------- | ||
other : Series or DataFrame | ||
other : Series, DataFrame or array-like | ||
The other object to compute the dot product with its columns. | ||
|
||
Returns | ||
------- | ||
dot_product : scalar or Series | ||
scalar, Series or numpy.ndarray | ||
Return the dot product of the Series and other if other is a | ||
Series, the Series of the dot product of Series and each rows of | ||
other if other is a DataFrame or a numpy.ndarray between the Series | ||
and each columns of the numpy array. | ||
|
||
See Also | ||
-------- | ||
DataFrame.dot: Compute dot product with the columns of the DataFrame. | ||
Series.mul: Multiplication of series and other, element-wise. | ||
|
||
Notes | ||
----- | ||
The Series and other has to share the same index if other is a Series | ||
or a DataFrame. | ||
|
||
Examples | ||
-------- | ||
>>> s = pd.Series([0, 1, 2, 3]) | ||
>>> other = pd.Series([-1, 2, -3, 4]) | ||
>>> s.dot(other) | ||
8 | ||
>>> df = pd.DataFrame([[0 ,1], [-2, 3], [4, -5], [6, 7]]) | ||
>>> s.dot(df) | ||
0 24 | ||
1 14 | ||
dtype: int64 | ||
>>> arr = np.array([[0, 1], [-2, 3], [4, -5], [6, 7]]) | ||
>>> s.dot(arr) | ||
array([24, 14]) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it probably makes more sense to show an example with a numpy array, more than with Python lists. I don't think (may be I'm wrong) in real cases it's so common to make operations between Python lists and pandas objects. But I'll leave that to you, whatever you think it makes more sense. |
||
""" | ||
from pandas.core.frame import DataFrame | ||
if isinstance(other, (Series, DataFrame)): | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if I'd add
Series.mul
here. Up to you.