File: IPInnerProduct.html

package info (click to toggle)
slepc 3.2-p5-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 11,356 kB
  • sloc: ansic: 34,162; makefile: 2,041; python: 1,411; fortran: 486; f90: 184; sh: 9
file content (47 lines) | stat: -rw-r--r-- 1,995 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc/slepc.css" type="text/css">
<TITLE>IPInnerProduct</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">

<H1>IPInnerProduct</H1>
Computes the inner product of two vectors. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcip.h" 
PetscErrorCode IPInnerProduct(IP ip,Vec x,Vec y,PetscScalar *p)
</PRE>
Collective on <A HREF="../IP/IP.html#IP">IP</A> and Vec
<P>
<H3><FONT COLOR="#883300">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ip </B></TD><TD> - the inner product context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>x  </B></TD><TD> - input vector
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>y  </B></TD><TD> - input vector
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Output Parameter</FONT></H3>
<DT><B>p </B> - result of the inner product
<br>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
This function will usually compute the standard dot product of vectors
x and y, (x,y)=y^H x. However this behaviour may be different if changed
via <A HREF="../IP/IPSetMatrix.html#IPSetMatrix">IPSetMatrix</A>(). This allows use of other inner products such as
the indefinite product y^T x for complex symmetric problems or the
B-inner product for positive definite B, (x,y)_B=y^H Bx.
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../IP/IPSetMatrix.html#IPSetMatrix">IPSetMatrix</A>(), VecDot(), <A HREF="../IP/IPMInnerProduct.html#IPMInnerProduct">IPMInnerProduct</A>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/ip/ipdot.c.html#IPInnerProduct">src/ip/ipdot.c</A>
<BR><A HREF="./index.html">Index of all IP routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>