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
48
49
50
51
52
53
54
55
56
57
58
59
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Vec/VecDotRealPart.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>VecDotRealPart</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.10.3 2018-12-18</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.10.3 v3.10.3 docs/manualpages/Vec/VecDotRealPart.html "><small>Report Typos and Errors</small></a></div>
<A NAME="VecDotRealPart"><H1>VecDotRealPart</H1></A>
Computes the real part of the vector dot product.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscvec.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Vec/VecDotRealPart.html#VecDotRealPart">VecDotRealPart</A>(<A HREF="../Vec/Vec.html#Vec">Vec</A> x,<A HREF="../Vec/Vec.html#Vec">Vec</A> y,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *val)
</PRE>
Collective on <A HREF="../Vec/Vec.html#Vec">Vec</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<DT><B>x, y </B> -the vectors
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>val </B> -the real part of the dot product;
<br>
<P>
<H3><FONT COLOR="#CC3333">Performance Issues</FONT></H3>
<pre>
per-processor memory bandwidth
</pre>
<pre>
interprocessor latency
</pre>
<pre>
work load inbalance that causes certain processes to arrive much earlier than others
</pre>
<P>
<H3><FONT COLOR="#CC3333">Notes for Users of Complex Numbers</FONT></H3>
See <A HREF="../Vec/VecDot.html#VecDot">VecDot</A>() for more details on the definition of the dot product for complex numbers
<P>
For real numbers this returns the same value as <A HREF="../Vec/VecDot.html#VecDot">VecDot</A>()
<P>
For complex numbers in C^n (that is a vector of n components with a complex number for each component) this is equal to the usual real dot product on the
the space R^{2n} (that is a vector of 2n components with the real or imaginary part of the complex numbers for components)
<P>
Developer Note: This is not currently optimized to compute only the real part of the dot product.
<P>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Vec/VecMDot.html#VecMDot">VecMDot</A>(), <A HREF="../Vec/VecTDot.html#VecTDot">VecTDot</A>(), <A HREF="../Vec/VecNorm.html#VecNorm">VecNorm</A>(), <A HREF="../Vec/VecDotBegin.html#VecDotBegin">VecDotBegin</A>(), <A HREF="../Vec/VecDotEnd.html#VecDotEnd">VecDotEnd</A>(), <A HREF="../Vec/VecDot.html#VecDot">VecDot</A>(), <A HREF="../Vec/VecDotNorm2.html#VecDotNorm2">VecDotNorm2</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/vec/vec/interface/rvector.c.html#VecDotRealPart">src/vec/vec/interface/rvector.c</A>
<BR><A HREF="./index.html">Index of all Vec 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>
|
