stan-dev/stan

deprecate int_step

Open

#2,433 建立於 2017年11月9日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)R (1,476 star) (270 fork)batch import
bugdocumentationgood first issue

描述

Summary:

int_step(x) and step(x) return different values for 0.

The version of step(x) matches the BUGS definition and the standard definition of the Heaviside step function. Therefore, it should not be changed.

Changing int_step()'s behavior would be confusing, so instead it should be deprecated and replaced with a suggestion to replace existing uses of int_step(n) with the boolean expression (n >= 0), which evaluates to 1 if n >= 0 and 0 otherwise.

Current Version:

v2.17.0

貢獻者指南

技術棧
無
領域
developer experience
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Stan language basicsDeprecation patterns in C++
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
Examine the source code for the step and int step functions, likely in src/stan/math/prim/scal/fun/. Add a deprecation warning to int step and update documentation to suggest using (n >= 0). Ensure consistency with the Heaviside step function definition.
deprecate int_step · stan-dev/stan#2433 | Good First Issue