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.