Skip to content

Commit

Permalink
Javadoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
maisonobe committed Feb 2, 2025
1 parent 333db67 commit 760499c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

import org.hipparchus.linear.RealMatrix;

/** Interface representing a Kalman estimate.
* @since 4.0
*/
public interface KalmanEstimate {

/** Get the current predicted state.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@
* <p>
* This implementation is attached to a filter using the observer mechanism. Once all measurements have been
* processed by the filter, the smoothing method can be called.
* </br>
* </p>
* <p>
* For example
* </p>
* <pre>{@code
* // Kalman filter
* final KalmanFilter<SimpleMeasurement> filter = new LinearKalmanFilter<>(decomposer, process, initialState);
Expand All @@ -47,7 +49,6 @@
* // Smooth backwards
* List<ProcessEstimate> smoothedStates = smoother.backwardsSmooth();
* }</pre>
* </p>
*
* @see "Särkkä, S. Bayesian Filtering and Smoothing. Cambridge 2013"
*/
Expand Down

0 comments on commit 760499c

Please sign in to comment.