X-Git-Url: https://gitweb.michael.orlitzky.com/?p=dunshire.git;a=blobdiff_plain;f=dunshire%2Fmatrices.py;h=f35827d16be600cec3ee5d1c2d0fbcea27a9484d;hp=a5a02e9d069eea87b2cf44cb70054133f3e4ae8c;hb=0274de467062ab29d2a41d2a91ec0b28fcd95c8d;hpb=8e261aea0119c04752bbb5925b4f4513f928271b diff --git a/dunshire/matrices.py b/dunshire/matrices.py index a5a02e9..f35827d 100644 --- a/dunshire/matrices.py +++ b/dunshire/matrices.py @@ -18,8 +18,11 @@ def append_col(left, right): Parameters ---------- - left, right : matrix - The two matrices to append to one another. + left : matrix + The "original" matrix, the one that will wind up on the left. + + right : matrix + The matrix to be appended on the right of ``left``. Returns ------- @@ -57,8 +60,11 @@ def append_row(top, bottom): Parameters ---------- - top, bottom : matrix - The two matrices to append to one another. + top : matrix + The "original" matrix, the one that will wind up on top. + + bottom : matrix + The matrix to be appended below ``top``. Returns ------- @@ -265,8 +271,11 @@ def inner_product(vec1, vec2): Parameters ---------- - vec1, vec2 : matrix - The two vectors whose inner product you want. + vec1 : matrix + The first vector, whose inner product with ``vec2`` you want. + + vec2 : matrix + The second vector, whose inner product with ``vec1`` you want. Returns ------- @@ -346,7 +355,7 @@ def specnorm(mat): Return the spectral norm of a matrix. The spectral norm of a matrix is its largest singular value, and it - corresponds to the operator norm induced by the vector ``2``-norm. + corresponds to the operator norm induced by the vector Euclidean norm. Parameters ----------