syntactically_valid_unit_name - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.
Our website is currently undergoing maintenance, which may result in occasional errors while browsing. We apologize for any inconvenience this may cause and are working swiftly to restore full functionality. Thank you for your patience.

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Mathematics : Numbers : Type Checking : syntactically_valid_unit_name

type/syntactically_valid_unit_name

check for a Maple unit name

 

Calling Sequence

Parameters

Description

Examples

Calling Sequence

type(expr, unit_name)

Parameters

expr

-

expression

Description

• 

A Maple expression is syntactically valid as a unit name is a symbol, a symbol indexed by a symbol, or a function that is either of these whose arguments are symbols.

• 

The type(expr, unit_name) function returns true if expr has the form of a syntactically valid unit name. Otherwise, false is returned.

• 

This type exists mostly for use by the Units package internally; if you are considering using this in your program to test something related to user functionality, then it is almost certainly not what you want. Consider instead using the type with_unit to find expressions with units attached, or specfunc(Units:-Unit) to find Unit function calls.

Examples

typemeter,syntactically_valid_unit_name

true

(1)

typemileUS_survey,syntactically_valid_unit_name

true

(2)

typemeterradius,syntactically_valid_unit_name

true

(3)

typefootstandardradius,syntactically_valid_unit_name

true

(4)

The type tests only whether expr would be valid as a unit name, not whether it is actually a unit that Maple knows about. For example, not_an_actual_unit would be a valid unit name, so this type returns true. However, it is not an actual unit that is defined in the Maple library.

typenot_an_actual_unit,syntactically_valid_unit_name

true

(5)

The expression ms would not be a valid unit name. (It is syntactically valid as a compound unit, which is tested by the type syntactically_valid_compound_unit.)

typems,syntactically_valid_unit_name

false

(6)

See Also

type

type/function

type/indexed

type/symbol

type/syntactically_valid_compound_unit

Units

Units/Index