X-Git-Url: https://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=src%2Fdunshire%2Fmatrices.py;h=2006fd20427b999fd8061a74e89e03508b55f0f1;hb=4bf45d1711033bc419e1c48a7906f21de67ef791;hp=0d97c0cbc4e83dfc95231a2306b870fb7b93a5db;hpb=814799cbabf73a2551532afa7f9e7128d9ae7bba;p=dunshire.git diff --git a/src/dunshire/matrices.py b/src/dunshire/matrices.py index 0d97c0c..2006fd2 100644 --- a/src/dunshire/matrices.py +++ b/src/dunshire/matrices.py @@ -83,6 +83,37 @@ def identity(domain_dim): return matrix(entries, (domain_dim, domain_dim)) +def inner_product(vec1, vec2): + """ + Compute the (Euclidean) inner product of the two vectors ``vec1`` + and ``vec2``. + + EXAMPLES: + + >>> x = [1,2,3] + >>> y = [3,4,1] + >>> inner_product(x,y) + 14 + + >>> x = matrix([1,1,1]) + >>> y = matrix([2,3,4], (1,3)) + >>> inner_product(x,y) + 9 + + >>> x = [1,2,3] + >>> y = [1,1] + >>> inner_product(x,y) + Traceback (most recent call last): + ... + TypeError: the lengths of vec1 and vec2 must match + + """ + if not len(vec1) == len(vec2): + raise TypeError('the lengths of vec1 and vec2 must match') + + return sum([x*y for (x, y) in zip(vec1, vec2)]) + + def norm(matrix_or_vector): """ Return the Frobenius norm of ``matrix_or_vector``, which is the same @@ -100,4 +131,43 @@ def norm(matrix_or_vector): 2.0 """ - return sqrt(sum([x**2 for x in matrix_or_vector])) + return sqrt(inner_product(matrix_or_vector, matrix_or_vector)) + + +def vec(real_matrix): + """ + Create a long vector in column-major order from ``real_matrix``. + + EXAMPLES: + + >>> A = matrix([[1,2],[3,4]]) + >>> print(A) + [ 1 3] + [ 2 4] + + + >>> print(vec(A)) + [ 1] + [ 2] + [ 3] + [ 4] + + + Note that if ``real_matrix`` is a vector, this function is a no-op: + + >>> v = matrix([1,2,3,4], (4,1)) + >>> print(v) + [ 1] + [ 2] + [ 3] + [ 4] + + >>> print(vec(v)) + [ 1] + [ 2] + [ 3] + [ 4] + + + """ + return matrix(real_matrix, (len(real_matrix), 1))