QuantEcon/QuantEcon.jl

LQ name conflict

Open

#229 opened on Dec 11, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Julia (495 stars) (300 forks)batch import
bughelp wanted

Description

Now that Julia has an LQ type (in the LinearAlgebra stdlib), there's a name conflict with the type exported by the package.

One way to handle this would be to change the following to ... struct LQProblem with the appropriate constructor.

mutable struct LQ
    Q::ScalarOrArray
    R::ScalarOrArray
    A::ScalarOrArray
    B::ScalarOrArray
    C::ScalarOrArray
    N::ScalarOrArray
    bet::Real
    capT::Union{Int, Nothing} # terminal period
    rf::ScalarOrArray
    P::ScalarOrArray
    d::Real
    F::ScalarOrArray # policy rule
end

https://github.com/QuantEcon/lecture-source-jl/issues/436

Contributor guide

Tech stack
None
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with Julia structsbasic understanding of QuantEcon package
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue is a name conflict with Julia's built in LQ type. The fix involves renaming the custom struct from LQ to LQProblem and updating all references. No maintainer clarification is needed. See the referenced issue for more context.