Skip to content

Commit

Permalink
Format SciML Style
Browse files Browse the repository at this point in the history
  • Loading branch information
@ChrisRackauckas
ChrisRackauckas committed Jun 23, 2022
1 parent ddbf2d6 commit 28d4767
Show file tree
Hide file tree
Showing 11 changed files with 210 additions and 170 deletions.
12 changes: 12 additions & 0 deletions .JuliaFormatter.toml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
style = "yas"
indent = 4
margin = 100
always_for_in = true
whitespace_ops_in_indices = true
whitespace_typedefs = false
remove_extra_newlines = true
import_to_using = true
pipe_to_function_call = false
short_to_long_function_def = false
always_use_return = true
whitespace_in_kwargs = true
42 changes: 42 additions & 0 deletions .github/workflows/FormatCheck.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: format-check

on:
push:
branches:
- 'master'
- 'release-'
tags: '*'
pull_request:

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
julia-version: [1]
julia-arch: [x86]
os: [ubuntu-latest]
steps:
- uses: julia-actions/setup-julia@latest
with:
version: ${{ matrix.julia-version }}

- uses: actions/checkout@v1
- name: Install JuliaFormatter and format
# This will use the latest version by default but you can set the version like so:
#
# julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))'
run: |
julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
julia -e 'using JuliaFormatter; format(".", verbose=true)'
- name: Format check
run: |
julia -e '
out = Cmd(`git diff --name-only`) |> read |> String
if out == ""
exit(0)
else
@error "Some files have not been formatted !!!"
write(stdout, out)
exit(1)
end'
8 changes: 3 additions & 5 deletions docs/make.jl
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
using Documenter, MathML

makedocs(sitename="My Documentation")
makedocs(; sitename = "My Documentation")

deploydocs(
repo = "github.com/anandijain/MathML.jl.git",
devbranch = "main",
)
deploydocs(; repo = "github.com/anandijain/MathML.jl.git",
devbranch = "main")
2 changes: 1 addition & 1 deletion src/MathML.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ module MathML
using DocStringExtensions

using EzXML, Symbolics, Statistics, IfElse, AbstractTrees
import SpecialFunctions
using SpecialFunctions: SpecialFunctions

include("utils.jl")
include("parse.jl")
Expand Down
235 changes: 109 additions & 126 deletions src/maps.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,129 +2,112 @@
# need to check the arities
# units handling??
applymap = Dict{String,Function}(
# eq sometimes needs to be ~ and sometimes needs to be =, not sure what the soln is
"eq" => x -> Symbolics.:~(x...), # arity 2,
"times" => Base.prod, # arity 2, but prod fine
# "prod" => Base.prod,
"divide" => x -> Base.:/(x...),
"power" => x -> Base.:^(x...),
"root" => custom_root,
"plus" => x -> Base.:+(x...),
"minus" => x -> Base.:-(x...),

# comparison functions implemented using the Heaviside function
"lt" => x -> H(x[2] - x[1] - ϵ),
"leq" => x -> H(x[2] - x[1]),
"geq" => x -> H(x[1] - x[2]),
"gt" => x -> H(x[1] - x[2] - ϵ),

# equal nodes are not part of the MathML specification and
# are generated by disambiguate_equality!
"equal" => x -> H(x[1] - x[2]) * H(x[2] - x[1]),
"neq" => x -> 1 - H(x[1] - x[2]) * H(x[2] - x[1]),

# "lt" => x -> Base.foldl(Base.:<, x),
# "leq" => x -> Base.foldl(Base.:≤, x),
# "geq" => x -> Base.foldl(Base.:≥, x),
# "gt" => x -> Base.foldl(Base.:>, x),

# "quotient" => x->Base.:div(x...), # broken, RoundingMode
"factorial" => x -> SpecialFunctions.gamma(1 .+ x[1]),
"max" => x -> Base.max(x...),
"min" => x -> Base.min(x...),
"rem" => x -> Base.:rem(x...),
"gcd" => x -> Base.:gcd(x...),

"and" => x -> Base.:*(x...),
"or" => heaviside_or,
"xor" => x -> x[1]*(one(x[2])-x[2]) + (one(x[1])-x[1])*x[2],
"not" => x -> one(x[1]) - x[1],

# "and" => x -> Base.:&(x...),
# "or" => Base.:|,
# "xor" => Base.:⊻,
# "not" => Base.:!,

"abs" => x -> Base.abs(x...),
"conjugate" => Base.conj,
"arg" => Base.angle,
"real" => Base.real,
"imaginary" => Base.imag,
"lcm" => x -> Base.lcm(x...),

"floor" => x -> x[1] - frac(x[1]),
"ceiling" => x -> x[1] - frac(x[1]) + one(x[1]),
"round" => x -> x[1] + 0.5 - frac(x[1] + 0.5),

# "floor" => x -> Base.floor(x...),
# "ceiling" => x -> Base.ceil(x...),
# "round" => x -> Base.round(x...),

"inverse" => Base.inv,
"compose" => x -> Base.:∘(x...),
"ident" => Base.identity,
"approx" => x -> Base.:≈(x...),

"sin" => x -> Base.sin(x...),
"cos" => x -> Base.cos(x...),
"tan" => x -> Base.tan(x...),
"sec" => x -> Base.sec(x...),
"csc" => x -> Base.csc(x...),
"cot" => x -> Base.cot(x...),
"arcsin" => x -> Base.asin(x...),
"arccos" => x -> Base.acos(x...),
"arctan" => x -> Base.atan(x...),
"arcsec" => x -> Base.asec(x...),
"arccsc" => x -> Base.acsc(x...),
"arccot" => x -> Base.acot(x...),
"sinh" => x -> Base.sinh(x...),
"cosh" => x -> Base.cosh(x...),
"tanh" => x -> Base.tanh(x...),
"sech" => x -> Base.sech(x...),
"csch" => x -> Base.csch(x...),
"coth" => x -> Base.coth(x...),
"arcsinh" => x -> Base.asinh(x...),
"arccosh" => x -> Base.acosh(x...),
"arctanh" => x -> Base.atanh(x...),
"arcsech" => x -> Base.asech(x...),
"arccsch" => x -> Base.acsch(x...),
"arccoth" => x -> Base.acoth(x...),

"exp" => x -> Base.exp(x...),
"log" => x -> Base.log10(x...), # todo handle <logbase>
"ln" => x -> Base.log(x...),

"mean" => Statistics.mean,
"sdev" => Statistics.std,
"variance" => Statistics.var,
"median" => Statistics.median,
# "mode" => Statistics.mode, # crazy mode isn't in Base

"vector" => Base.identity,
"diff" => parse_diff,
"cn" => parse_diff,
# "apply" => x -> parse_apply(x) # this wont work because we pass the name which is string
)

tagmap = Dict{String,Function}(
"cn" => parse_cn,
"ci" => parse_ci,

"degree" => x -> parse_node(x.firstelement), # won't work for all cases
"bvar" => parse_bvar, # won't work for all cases

"piecewise" => parse_piecewise,

"apply" => parse_apply,
"math" => x -> map(parse_node, elements(x)),
"vector" => x -> map(parse_node, elements(x)),
"lambda" => parse_lambda,

# MathML defined constants
"pi" => x -> π,
"exponentiale" => x -> ℯ,
"notanumber" => x -> NaN,
"infinity" => x -> Inf,
"true" => x -> true,
"false" => x -> false,
)
# eq sometimes needs to be ~ and sometimes needs to be =, not sure what the soln is
"eq" => x -> Symbolics.:~(x...), # arity 2,
"times" => Base.prod, # arity 2, but prod fine
# "prod" => Base.prod,
"divide" => x -> Base.:/(x...),
"power" => x -> Base.:^(x...),
"root" => custom_root,
"plus" => x -> Base.:+(x...),
"minus" => x -> Base.:-(x...),

# comparison functions implemented using the Heaviside function
"lt" => x -> H(x[2] - x[1] - ϵ),
"leq" => x -> H(x[2] - x[1]),
"geq" => x -> H(x[1] - x[2]),
"gt" => x -> H(x[1] - x[2] - ϵ),

# equal nodes are not part of the MathML specification and
# are generated by disambiguate_equality!
"equal" => x -> H(x[1] - x[2]) * H(x[2] - x[1]),
"neq" => x -> 1 - H(x[1] - x[2]) * H(x[2] - x[1]),

# "lt" => x -> Base.foldl(Base.:<, x),
# "leq" => x -> Base.foldl(Base.:≤, x),
# "geq" => x -> Base.foldl(Base.:≥, x),
# "gt" => x -> Base.foldl(Base.:>, x),

# "quotient" => x->Base.:div(x...), # broken, RoundingMode
"factorial" => x -> SpecialFunctions.gamma(1 .+ x[1]),
"max" => x -> Base.max(x...),
"min" => x -> Base.min(x...),
"rem" => x -> Base.:rem(x...),
"gcd" => x -> Base.:gcd(x...), "and" => x -> Base.:*(x...),
"or" => heaviside_or,
"xor" => x -> x[1] * (one(x[2]) - x[2]) + (one(x[1]) - x[1]) * x[2],
"not" => x -> one(x[1]) - x[1],

# "and" => x -> Base.:&(x...),
# "or" => Base.:|,
# "xor" => Base.:⊻,
# "not" => Base.:!,

"abs" => x -> Base.abs(x...),
"conjugate" => Base.conj,
"arg" => Base.angle,
"real" => Base.real,
"imaginary" => Base.imag,
"lcm" => x -> Base.lcm(x...), "floor" => x -> x[1] - frac(x[1]),
"ceiling" => x -> x[1] - frac(x[1]) + one(x[1]),
"round" => x -> x[1] + 0.5 - frac(x[1] + 0.5),

# "floor" => x -> Base.floor(x...),
# "ceiling" => x -> Base.ceil(x...),
# "round" => x -> Base.round(x...),

"inverse" => Base.inv,
"compose" => x -> Base.:∘(x...),
"ident" => Base.identity,
"approx" => x -> Base.:≈(x...), "sin" => x -> Base.sin(x...),
"cos" => x -> Base.cos(x...),
"tan" => x -> Base.tan(x...),
"sec" => x -> Base.sec(x...),
"csc" => x -> Base.csc(x...),
"cot" => x -> Base.cot(x...),
"arcsin" => x -> Base.asin(x...),
"arccos" => x -> Base.acos(x...),
"arctan" => x -> Base.atan(x...),
"arcsec" => x -> Base.asec(x...),
"arccsc" => x -> Base.acsc(x...),
"arccot" => x -> Base.acot(x...),
"sinh" => x -> Base.sinh(x...),
"cosh" => x -> Base.cosh(x...),
"tanh" => x -> Base.tanh(x...),
"sech" => x -> Base.sech(x...),
"csch" => x -> Base.csch(x...),
"coth" => x -> Base.coth(x...),
"arcsinh" => x -> Base.asinh(x...),
"arccosh" => x -> Base.acosh(x...),
"arctanh" => x -> Base.atanh(x...),
"arcsech" => x -> Base.asech(x...),
"arccsch" => x -> Base.acsch(x...),
"arccoth" => x -> Base.acoth(x...), "exp" => x -> Base.exp(x...),
"log" => x -> Base.log10(x...), # todo handle <logbase>
"ln" => x -> Base.log(x...), "mean" => Statistics.mean,
"sdev" => Statistics.std,
"variance" => Statistics.var,
"median" => Statistics.median,
# "mode" => Statistics.mode, # crazy mode isn't in Base

"vector" => Base.identity,
"diff" => parse_diff,
"cn" => parse_diff
# "apply" => x -> parse_apply(x) # this wont work because we pass the name which is string
)

tagmap = Dict{String,Function}("cn" => parse_cn,
"ci" => parse_ci, "degree" => x -> parse_node(x.firstelement), # won't work for all cases
"bvar" => parse_bvar, # won't work for all cases
"piecewise" => parse_piecewise, "apply" => parse_apply,
"math" => x -> map(parse_node, elements(x)),
"vector" => x -> map(parse_node, elements(x)),
"lambda" => parse_lambda,

# MathML defined constants
"pi" => x -> π,
"exponentiale" => x -> ℯ,
"notanumber" => x -> NaN,
"infinity" => x -> Inf,
"true" => x -> true,
"false" => x -> false)
Loading

0 comments on commit 28d4767

Please sign in to comment.