Skip to content

Update docs for TABLE statement#2885

Merged
pramodk merged 3 commits into
masterfrom
jelic/update_table_docs
Jun 17, 2024
Merged

Update docs for TABLE statement#2885
pramodk merged 3 commits into
masterfrom
jelic/update_table_docs

Conversation

@JCGoran

@JCGoran JCGoran commented May 28, 2024

Copy link
Copy Markdown
Collaborator

Add more details about how to use the TABLE statement and how it works.

@pramodk pramodk requested a review from nrnhines May 28, 2024 15:38
@azure-pipelines

Copy link
Copy Markdown

✔️ e122c18 -> Azure artifacts URL

which specifies that the tables are to be used (1, default) or not used (0).

With usetable_suffix = 0, when the procedure is called it ignores the tables
With ``usetable_<suffix> = 0``, when the procedure is called it ignores the tables

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
With ``usetable_<suffix> = 0``, when the procedure is called it ignores the tables
With ``usetable_<suffix> == 0``, when the procedure is called it ignores the tables


With usetable_suffix = 1, when the procedure is called, the
arg value is used to assign values to the "variables" by looking them up
With ``usetable_<suffix> = 1``, when the procedure is called, the

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
With ``usetable_<suffix> = 1``, when the procedure is called, the
With ``usetable_<suffix> == 1``, when the procedure is called, the

is saved. If the tables are out of date (a "dependency" has a different
is saved. If the tables are out of date (any of the ``dependencies`` has a different
value from its value the last time the tables were constructed) or have never
been created, the tables are created.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be split into two sentences:

A table is considered out-of-date if any of the ``dependencies`` has changed its value since the last time the table was constructed. If the table is out-of-date or has never been constructed it's (re-)created.

Though it might not be helpful.

time than an interpolated table lookup.

Also note that for any argument value outside of the interpolation range,
the returned value of a function with a TABLE will always be the value at

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think only if the table is used will it clamp.


Also note that for any argument value outside of the interpolation range,
the returned value of a function with a TABLE will always be the value at
the boundary (value at ``lowest`` if argument value is smaller than ``lowest``,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
the boundary (value at ``lowest`` if argument value is smaller than ``lowest``,
the boundary, i.e. the value at ``lowest`` if argument value is smaller than ``lowest``, or the

A math formula might be more effective.

Also note that for any argument value outside of the interpolation range,
the returned value of a function with a TABLE will always be the value at
the boundary (value at ``lowest`` if argument value is smaller than ``lowest``,
value at ``highest`` if argument value is larger than ``highest``).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
value at ``highest`` if argument value is larger than ``highest``).
value at ``highest`` if argument value is larger than ``highest``.

@1uc 1uc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good additions!

@codecov

codecov Bot commented May 28, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.21%. Comparing base (71bf299) to head (58485cc).
Report is 7 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2885      +/-   ##
==========================================
+ Coverage   67.20%   67.21%   +0.01%     
==========================================
  Files         563      569       +6     
  Lines      104254   104712     +458     
==========================================
+ Hits        70059    70386     +327     
- Misses      34195    34326     +131     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bbpbuildbot

This comment has been minimized.

Comment thread docs/python/modelspec/programmatic/mechanisms/nmodl.rst Outdated
@azure-pipelines

Copy link
Copy Markdown

✔️ 51707da -> Azure artifacts URL

@bbpbuildbot

This comment has been minimized.

Comment thread docs/python/modelspec/programmatic/mechanisms/nmodl.rst Outdated
@sonarqubecloud

sonarqubecloud Bot commented Jun 4, 2024

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@azure-pipelines

Copy link
Copy Markdown

✔️ 58485cc -> Azure artifacts URL

@pramodk

pramodk commented Jun 17, 2024

Copy link
Copy Markdown
Member

I see some old suggestions but also see that PR was updated and approved afterward. So I will merge this.

@pramodk pramodk merged commit e49f45f into master Jun 17, 2024
@pramodk pramodk deleted the jelic/update_table_docs branch June 17, 2024 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants