feat: add hasname function

SciML · Nov 21, 2023 · 5b6e191 · 5b6e191
1 parent 064d9f0
commit 5b6e191
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -22,6 +22,7 @@ ScalarSymbolic
 ArraySymbolic
 NotSymbolic
 symbolic_type
+hasname
 getname
 ```
 

diff --git a/src/SymbolicIndexingInterface.jl b/src/SymbolicIndexingInterface.jl
@@ -2,7 +2,7 @@ module SymbolicIndexingInterface
 
 using Requires
 
-export ScalarSymbolic, ArraySymbolic, NotSymbolic, symbolic_type , getname
+export ScalarSymbolic, ArraySymbolic, NotSymbolic, symbolic_type, hasname, getname
 include("trait.jl")
 
 export is_variable, variable_index, variable_symbols, is_parameter, parameter_index,

diff --git a/src/trait.jl b/src/trait.jl
@@ -40,6 +40,15 @@ symbolic_type(x) = symbolic_type(typeof(x))
 symbolic_type(::Type) = NotSymbolic()
 symbolic_type(::Type{Symbol}) = ScalarSymbolic()
 
+"""
+    hasname(x)
+
+Check whether the given symbolic variable (for which `symbolic_type(x) != NotSymbolic()`) has a valid name as per `getname`.
+"""
+function hasname end
+
+hasname(::Symbol) = true
+hasname(::Any) = false
 
 """
     getname(x)::Symbol
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,6 +22,7 @@ ScalarSymbolic @@
     ArraySymbolic
     NotSymbolic
     symbolic_type
+    hasname
     getname
     ```
@@ Expand Down @@