mirror of
https://github.com/boostorg/odeint.git
synced 2025-05-11 21:44:03 +00:00
144 lines
6.5 KiB
HTML
144 lines
6.5 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>Observer</title>
|
|
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
|
|
<link rel="home" href="../../index.html" title="Chapter 1. boost.sandbox.numeric.odeint">
|
|
<link rel="up" href="../concepts.html" title="Concepts">
|
|
<link rel="prev" href="implicit_system.html" title="Implicit System">
|
|
<link rel="next" href="stepper.html" title="Stepper">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="implicit_system.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="stepper.html"><img src="../../images/next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h3 class="title">
|
|
<a name="boost_sandbox_numeric_odeint.concepts.observer"></a><a class="link" href="observer.html" title="Observer">Observer</a>
|
|
</h3></div></div></div>
|
|
<h5>
|
|
<a name="boost_sandbox_numeric_odeint.concepts.observer.h0"></a>
|
|
<span><a name="boost_sandbox_numeric_odeint.concepts.observer.description"></a></span><a class="link" href="observer.html#boost_sandbox_numeric_odeint.concepts.observer.description">Description</a>
|
|
</h5>
|
|
<p>
|
|
The Observer concept is used in <code class="computeroutput"><span class="identifier">integrate</span></code>
|
|
routines to allow the user to analyze the state during the subsequent steps.
|
|
Observers are callable objects with a specific parameter pattern as shown
|
|
below. Provided to an <code class="computeroutput"><span class="identifier">integrate</span></code>
|
|
function, observers are called at each time step, at equidistant time points
|
|
or at user defined time points depending on which <code class="computeroutput"><span class="identifier">integrate</span></code>
|
|
function is used.
|
|
</p>
|
|
<h5>
|
|
<a name="boost_sandbox_numeric_odeint.concepts.observer.h1"></a>
|
|
<span><a name="boost_sandbox_numeric_odeint.concepts.observer.notation"></a></span><a class="link" href="observer.html#boost_sandbox_numeric_odeint.concepts.observer.notation">Notation</a>
|
|
</h5>
|
|
<div class="variablelist">
|
|
<p class="title"><b></b></p>
|
|
<dl>
|
|
<dt><span class="term"><code class="computeroutput"><span class="identifier">Observer</span></code></span></dt>
|
|
<dd><p>
|
|
A type that is a model of Observer
|
|
</p></dd>
|
|
<dt><span class="term"><code class="computeroutput"><span class="identifier">State</span></code></span></dt>
|
|
<dd><p>
|
|
A type that is the <code class="computeroutput"><span class="identifier">state_type</span></code>
|
|
</p></dd>
|
|
<dt><span class="term"><code class="computeroutput"><span class="identifier">Time</span></code></span></dt>
|
|
<dd><p>
|
|
A type that is the <code class="computeroutput"><span class="identifier">time_type</span></code>
|
|
</p></dd>
|
|
<dt><span class="term"><code class="computeroutput"><span class="identifier">obs</span></code></span></dt>
|
|
<dd><p>
|
|
An object that models <code class="computeroutput"><span class="identifier">System</span></code>
|
|
</p></dd>
|
|
<dt><span class="term"><code class="computeroutput"><span class="identifier">x</span></code></span></dt>
|
|
<dd><p>
|
|
Object of type <code class="computeroutput"><span class="identifier">State</span></code>
|
|
</p></dd>
|
|
<dt><span class="term"><code class="computeroutput"><span class="identifier">t</span></code></span></dt>
|
|
<dd><p>
|
|
Object of type <code class="computeroutput"><span class="identifier">Time</span></code>
|
|
</p></dd>
|
|
</dl>
|
|
</div>
|
|
<h5>
|
|
<a name="boost_sandbox_numeric_odeint.concepts.observer.h2"></a>
|
|
<span><a name="boost_sandbox_numeric_odeint.concepts.observer.valid_expressions"></a></span><a class="link" href="observer.html#boost_sandbox_numeric_odeint.concepts.observer.valid_expressions">Valid
|
|
Expressions</a>
|
|
</h5>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col>
|
|
<col>
|
|
<col>
|
|
<col>
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th>
|
|
<p>
|
|
Name
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Expression
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Type
|
|
</p>
|
|
</th>
|
|
<th>
|
|
<p>
|
|
Semantics
|
|
</p>
|
|
</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td>
|
|
<p>
|
|
Perform the observation
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="identifier">obs</span><span class="special">(</span>
|
|
<span class="identifier">x</span> <span class="special">,</span>
|
|
<span class="identifier">t</span> <span class="special">)</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
<code class="computeroutput"><span class="keyword">void</span></code>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
Calls the observer which can do some analyzation of the state
|
|
<span class="emphasis"><em>x</em></span> at time <span class="emphasis"><em>t</em></span>.
|
|
</p>
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
|
<td align="left"></td>
|
|
<td align="right"><div class="copyright-footer">Copyright © 2009-2011 Karsten Ahnert
|
|
and Mario Mulansky<p>
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
|
|
</p>
|
|
</div></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="implicit_system.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="stepper.html"><img src="../../images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|