Reference Manual Style Guide and Peaksigmoid: Difference between pages

From Eigenvector Research Documentation Wiki
(Difference between pages)
Jump to navigation Jump to search
imported>Jeremy
No edit summary
 
imported>Mathias
 
Line 1: Line 1:
The following style rules should be followed for all new reference manual entries. See the [[Reference Manual Template]] page for a starting template page.
===Purpose===
Outputs a sigmoid function.


==Top-level Segments==
These segment titles are wrapped with three =s  <nowiki>===Synopsis===</nowiki> and include:
*Purpose
*Synopsis
*Description
*Examples
*Options
*Algorithm
*See Also


==Sub-Topics==
===Synopsis===
Some standard sub-topics can be used in the Description section. These sub-topic titles are wrapped with four =s <nowiki>====Inputs====</nowiki> and  include:
*Inputs
*Optional Inputs
*Outputs


The contents of these sections should be given as bulleted lists with each input/output as a separate item in the list.
:[y,y1,y2] = peaksigmoid(x,ax)


Note: These sub-topics are ''always plural'', even if there is only one item in the list (e.g. one output)


===Inputs===


==Options==
* '''x''' = 3 element vector where
Options
:* x(1) = coefficient
:* x(2) = offset
:* x(3) = decay constant


==Matlab Code==
===Outputs===
Matlab code can be included in the body of the description using either:
* Indenting (i.e. start line with a semicolon) - use for Synopsis section and for single lines of code in description
::indented code looks like this
* Preformatted code using one of the methods below - use any time there are multiple lines of associated code shown together
** start line with one or more space characters
** wrap code in a &lt;pre&gt; &lt;/pre&gt; tag
<pre>
      preformatted code looks like this
</pre>


==See Also==
 
* See Also section should list relevant similar functions and link to each function
 
 
<math>\sqrt{1-e^2}</math>
 
<math>f\left( {{a}_{i}},\mathbf{x} \right)={{x}_{1}}\left[ {{x}_{4}}{{\operatorname{e}}^{\frac{-4\ln \left( 2 \right){{\left( {{a}_{i}}-{{x}_{2}} \right)}^{2}}}{x_{3}^{2}}}}+\left( 1-{{x}_{4}} \right)\left[ \frac{x_{3}^{2}}{{{\left( {{a}_{i}}-{{x}_{2}} \right)}^{2}}+x_{3}^{2}} \right] \right]</math>
 
 
<math>f\left( {{a}_{i}},\mathbf{x} \right)={{x}_{1}}\left[ {{x}_{4}}{{\operatorname{e}}^{\frac{-4\ln \left( 2 \right){{\left( {{a}_{i}}-{{x}_{2}} \right)}^{2}}}{x_{3}^{2}}}}+\left( 1-{{x}_{4}} \right)\left[ \frac{1-x_{3}^{2}}{{{\left( {1}+{{x}_{2}} \right)}^{2}}+x_{3}^{2}} \right] \right]</math>
 
 
 
<math>f\left( {{a}_{i}},\mathbf{x} \right)={{x}_{1}}\left[ {}+\left( 1-{{x}_{4}} \right)\left[ \frac{1-x_{3}^{2}}{{{\left( \right)}+x_{3}^{2}} \right] \right]</math>
 
* '''y(1) ''' =  
 
* '''y(2)  '''  = <math>{\operatorname{d}\!y\over\operatorname{d}\!{x}_{i}}</math>
 
* ''' y(3)  '''  = <math>{\operatorname{d^2}\!y\over\operatorname{d}\!{{x}_{i}}^{2}}</math>

Revision as of 11:37, 4 August 2016

Purpose

Outputs a sigmoid function.


Synopsis

[y,y1,y2] = peaksigmoid(x,ax)


Inputs

  • x = 3 element vector where
  • x(1) = coefficient
  • x(2) = offset
  • x(3) = decay constant

Outputs



Failed to parse (SVG (MathML can be enabled via browser plugin): Invalid response ("Math extension cannot connect to Restbase.") from server "https://wikimedia.org/api/rest_v1/":): {\displaystyle f\left( {{a}_{i}},\mathbf{x} \right)={{x}_{1}}\left[ {}+\left( 1-{{x}_{4}} \right)\left[ \frac{1-x_{3}^{2}}{{{\left( \right)}+x_{3}^{2}} \right] \right]}

  • y(1) =
  • y(2) =
  • y(3) =