matlab.mpm.Version

Package version

Since R2024b

Description

A matlab.mpm.Version object stores package version information. You can use a version object to limit searches for packages using mpmsearch.

Creation

Syntax

pkgver = matlab.mpm.Version(major,minor,patchnum)

pkgver = matlab.mpm.Version(versionstr)

pkgver = matlab.mpm.Version(___,Prerelease=prver)

pkgver = matlab.mpm.Version(___,Prerelease=prver,Build=buildver)

Description

pkgver = matlab.mpm.Version(major,minor,patchnum) creates a package version object where each input corresponds to an element of semantic version syntax.

pkgver = matlab.mpm.Version(versionstr) creates a package version object corresponding to the specified string. versionstr must follow semantic version syntax.

pkgver = matlab.mpm.Version(___,Prerelease=prver) creates a package version object with the specified prerelease version.

pkgver = matlab.mpm.Version(___,Prerelease=prver,Build=buildver) creates a package version object with the specified build version.

Input Arguments

major — Major version

nonnegative integer scalar

Major version, specified as a nonnegative integer scalar.

This argument sets the Major property.

minor — Minor version

nonnegative integer scalar

Minor version, specified as a nonnegative integer scalar.

This argument sets the Minor property.

patchnum — Patch version

nonnegative integer scalar

Patch version, specified as a nonnegative integer scalar.

This argument sets the Patch property.

versionstr — Version string

string scalar

Version string, specified as a string scalar containing a semantic version.

Based on the format of the string, this argument sets properties of the package version object.

Example: "1.2.3"

Example: "1.2.3-alpha"

Example: "1.2.3-alpha+exp"

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: matlab.mpm.Version(1,2,3,Prerelease="alpha",Build="exp")

prver — Pre-release version

string row vector

Pre-release version, specified as a string row vector.

This argument sets the Prerelease property.

Example: "alpha"

Example: ["alpha" "1"]

buildver — Build version

string row vector

Build version, specified as a string row vector.

This argument sets the Build property.

Example: "exp"

Example: ["exp" "sha" "4225k32"]

Properties

Major — Major version

double scalar

Major version, specified as a double scalar.

Minor — Minor version

double scalar

Minor version, specified as a double scalar.

Patch — Patch version

double scalar

Patch version, specified as a double scalar.

Prerelease — Pre-release version

string row vector

Pre-release version, specified as a string row vector.

Build — Build version

string row vector

Build version, specified as a string row vector.

Examples

Create Package Version

Create a package version object.

pkgver = matlab.mpm.Version(1,2,3)

pkgver = 

  Version with properties:

         Major: 1
         Minor: 2
         Patch: 3
    Prerelease: [1×0 string]
         Build: [1×0 string]

Create Package Version Using String

Create a package version object using a string input.

pkgver = matlab.mpm.Version("1.2.3-alpha+exp")

pkgver = 

  Version with properties:

         Major: 1
         Minor: 2
         Patch: 3
    Prerelease: "alpha"
         Build: "exp"

Create Package Version with Prerelease Version

Create a package version object.

pkgver = matlab.mpm.Version(1,2,3,Prerelease="alpha")

pkgver = 

  Version with properties:

         Major: 1
         Minor: 2
         Patch: 3
    Prerelease: "alpha"
         Build: [1×0 string]

Create Package Version with Prerelease Version and Build Version

Create a package version object.

pkgver = matlab.mpm.Version(1,2,3,Prerelease="alpha",Build="exp")

pkgver = 

  Version with properties:

         Major: 1
         Minor: 2
         Patch: 3
    Prerelease: "alpha"
         Build: "exp"

More About

Semantic Version Syntax

Version syntax follows the Semantic Versioning 2.0.0 format: <major version>.<minor version>.<patch version>, where each version number must be a nonnegative integer, for example 1.2.3. You can optionally specify a pre-release version by adding -<pre-release version> to the end of the version, for example 1.2.3-alpha. Optionally specify a build version by adding +<build version>.

Specify a range of versions by including the <, <=, >, or >= operators in front of a version number. For example, >2.1.13 specifies all versions greater than 2.1.13. Specify more than one range separated by white space to further limit matches. For example, >2.1.13 <=2.1.15 includes versions 2.1.14 and 2.1.15, but not 2.1.13 or 2.1.16. Use the || operator to designate multiple acceptable version ranges. For example, <2.1.13 || >2.1.15 includes versions less than 2.1.13 and greater than 2.1.15, but not 2.1.14.

Tips

• Equality between mpm.matlab.Version objects follows Semantic Versioning 2.0.0 standards and ignores the Build property. For example, compare two version objects with different Build values:

  v1 = matlab.mpm.Version(1,2,3,Build="a");
  v2 = matlab.mpm.Version(1,2,3,Build="b");
  v1 == v2

  ans =
  
    logical
  
     1

Extended Capabilities

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

This function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

Introduced in R2024b