type/syntactically_valid_compound_unit - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : Data Types : Type Checking : Types : type/syntactically_valid_compound_unit

type/syntactically_valid_compound_unit

check syntactically for a valid compound unit

 

Calling Sequence

Parameters

Description

Examples

Calling Sequence

type(expr, syntactically_valid_compound_unit)

Parameters

expr

-

expression

Description

• 

A Maple expression is syntactically valid as a compound unit if it is a product of rational powers of syntactically valid unit names, possibly further multiplied by a constant.

• 

The type(expr, syntactically_valid_compound_unit) function returns true if expr has the form of a syntactically valid compound unit. 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

typemeter2,syntactically_valid_compound_unit

true

(1)

typeL100km,syntactically_valid_compound_unit

true

(2)

typekgm2s3,syntactically_valid_compound_unit

true

(3)

typenewtonmeterradius,syntactically_valid_compound_unit

true

(4)

The type tests only whether expr would be valid as a compound unit, not whether it is actually a unit that Maple knows about. For example, not_an_actual_unit would be a valid unit name (and by extension a valid compound unit), 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_compound_unit

true

(5)

The expression for a distance of 2 meters plus 3 feet would not be valid as a compound unit.

distance2Unitm+3Unitft

distance2m+3ft

(6)

typedistance,syntactically_valid_compound_unit

false

(7)

See Also

type

type/constant

type/syntactically_valid_unit_name

type/with_unit

Units

Units/Index