Skip to content

Commit fd09e25

Browse files
author
Documenter.jl
committed
build based on aaeefa8 
1 parent 851ba96 commit fd09e25

File tree

79 files changed

+15201
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+15201
-0
lines changed

‎previews/PR379/.documenter-siteinfo.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"documenter":{"julia_version":"1.12.4","generation_timestamp":"2026-01-29T10:50:45","documenter_version":"1.16.1"}}

‎previews/PR379/api/inits/add_jumps!/index.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>add_jumps! · ReservoirComputing.jl</title><meta name="title" content="add_jumps! · ReservoirComputing.jl"/><meta property="og:title" content="add_jumps! · ReservoirComputing.jl"/><meta property="twitter:title" content="add_jumps! · ReservoirComputing.jl"/><meta name="description" content="Documentation for ReservoirComputing.jl."/><meta property="og:description" content="Documentation for ReservoirComputing.jl."/><meta property="twitter:description" content="Documentation for ReservoirComputing.jl."/><meta property="og:url" content="https://docs.sciml.ai/ReservoirComputing/stable/api/inits/add_jumps!/"/><meta property="twitter:url" content="https://docs.sciml.ai/ReservoirComputing/stable/api/inits/add_jumps!/"/><link rel="canonical" href="https://docs.sciml.ai/ReservoirComputing/stable/api/inits/add_jumps!/"/><script data-outdated-warner src="../../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../../assets/documenter.js"></script><script src="../../../search_index.js"></script><script src="../../../siteinfo.js"></script><script src="../../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../../assets/themeswap.js"></script><link href="../../../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../../"><img src="../../../assets/logo.png" alt="ReservoirComputing.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../../">ReservoirComputing.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../../">ReservoirComputing.jl</a></li><li><a class="tocitem" href="../../../tutorials/getting_started/">Getting Started with ReservoirComputing.jl</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../../../tutorials/scratch/">Building a model from scratch</a></li><li><a class="tocitem" href="../../../tutorials/lorenz_basic/">Chaos forecasting with an ESN</a></li><li><a class="tocitem" href="../../../tutorials/ngrc/">Fitting a Next Generation Reservoir Computer</a></li><li><a class="tocitem" href="../../../tutorials/deep_esn/">Deep Echo State Networks</a></li><li><a class="tocitem" href="../../../tutorials/train/">Training Reservoir Computing Models</a></li><li><a class="tocitem" href="../../../tutorials/reca/">Reservoir Computing with Cellular Automata</a></li><li><a class="tocitem" href="../../../tutorials/saveload/">Saving and loading models</a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../../../examples/model_es2n/">Building a model to add to ReservoirComputing.jl</a></li></ul></li><li><span class="tocitem">API Documentation</span><ul><li><a class="tocitem" href="../../layers/">Layers</a></li><li><a class="tocitem" href="../../models/">Models</a></li><li><a class="tocitem" href="../../utils/">Utilities</a></li><li><a class="tocitem" href="../../train/">Train</a></li><li><a class="tocitem" href="../../predict/">Predict</a></li><li><a class="tocitem" href="../../states/">States</a></li><li><a class="tocitem" href="../">Initializers</a></li></ul></li><li><a class="tocitem" href="../../../references/">References</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>add_jumps!</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>add_jumps!</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/SciML/ReservoirComputing.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/SciML/ReservoirComputing.jl/blob/master/docs/src/api/inits/add_jumps!.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="add_jumps!"><a class="docs-heading-anchor" href="#add_jumps!">add_jumps!</a><a id="add_jumps!-1"></a><a class="docs-heading-anchor-permalink" href="#add_jumps!" title="Permalink"></a></h1><article><details class="docstring" open="true"><summary id="ReservoirComputing.add_jumps!"><a class="docstring-binding" href="#ReservoirComputing.add_jumps!"><code>ReservoirComputing.add_jumps!</code></a> — <span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">add_jumps!([rng], reservoir_matrix, weight, jump_size;
3+
sampling_type=:no_sample, irrational=pi, start=1,
4+
positive_prob=0.5)</code></pre><p>Adds jumps to a given <code>reservoir_matrix</code> with chosen <code>weight</code> and determined <code>jump_size</code>. <code>weight</code> can be either a number or an array.</p><p><strong>Arguments</strong></p><ul><li><code>rng</code>: Random number generator. Default is <code>Utils.default_rng()</code> from WeightInitializers.</li><li><code>reservoir_matrix</code>: matrix to be changed.</li><li><code>weight</code>: weight to add as a simple cycle. Can be either a single number or an array.</li><li><code>jump_size</code>: size of the jump&#39;s distance.</li></ul><p><strong>Keyword arguments</strong></p><ul><li><code>sampling_type</code>: Sampling that decides the distribution of <code>weight</code> negative numbers. If set to <code>:no_sample</code> the sign is unchanged. If set to <code>:bernoulli_sample!</code> then each <code>weight</code> can be positive with a probability set by <code>positive_prob</code>. If set to <code>:irrational_sample!</code> the <code>weight</code> is negative if the decimal number of the irrational number chosen is odd. If set to <code>:regular_sample!</code>, each weight will be assigned a negative sign after the chosen <code>strides</code>. <code>strides</code> can be a single number or an array. Default is <code>:no_sample</code>.</li><li><code>positive_prob</code>: probability of the <code>weight</code> being positive when <code>sampling_type</code> is set to <code>:bernoulli_sample!</code>. Default is 0.5.</li><li><code>irrational</code>: Irrational number whose decimals decide the sign of <code>weight</code>. Default is <code>pi</code>.</li><li><code>start</code>: Which place after the decimal point the counting starts for the <code>irrational</code> sign counting. Default is 1.</li><li><code>strides</code>: number of strides for assigning negative value to a weight. It can be an integer or an array. Default is 2.</li></ul><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; matrix = zeros(Float32, 5, 5)
5+
5×5 Matrix{Float32}:
6+
0.0 0.0 0.0 0.0 0.0
7+
0.0 0.0 0.0 0.0 0.0
8+
0.0 0.0 0.0 0.0 0.0
9+
0.0 0.0 0.0 0.0 0.0
10+
0.0 0.0 0.0 0.0 0.0
11+
12+
julia&gt; add_jumps!(matrix, 1.0)
13+
5×5 Matrix{Float32}:
14+
0.0 0.0 1.0 0.0 0.0
15+
0.0 0.0 0.0 0.0 0.0
16+
1.0 0.0 0.0 0.0 0.0
17+
0.0 0.0 0.0 0.0 1.0
18+
0.0 0.0 1.0 0.0 0.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/ReservoirComputing.jl/blob/aaeefa8d6754589fc96dda7d82a48624f6967a96/src/inits/inits_components.jl#L509-L563">source</a></section></details></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.16.1 on <span class="colophon-date" title="Thursday 29 January 2026 10:50">Thursday 29 January 2026</span>. Using Julia version 1.12.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)