stan-dev/stan

Remove unused variational::base_family class

Open

#1,695 opened on Nov 19, 2015

View on GitHub
 (6 comments) (0 reactions) (1 assignee)R (270 forks)batch import
code cleanupgood first issue

Repository metrics

Stars
 (1,476 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The base class variational::base_family has no virtual methods and the one function it does define uses no member variables or functions, so can be made standalone outside of the class. Therefore, base_family should be removed.

  • remove src/stan/variational/base_family.hpp
  • move function write_error_msg_() into its own file and rename without suffix _
  • patch families/normal_meanfield.hpp and families/normal_fullrank.hpp:
    • remove references to base_family
    • change calls to write_error_msg_ to include and call new function

If the intent was to somehow pull down some of the functionality from the subclasses, then this issue should be repurposed to do that.

Contributor guide

Research direction
Remove the base family class and its header, move write error msg () to its own file, and update includes in the derived classes.
Tech stack
cpp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80