Main Content

getNumDataPointsInfo

Get information about number of data points in generated data

Description

example

datainfo = getNumDataPointsInfo(datagenerator) returns information about the data points generated by the fixed.DataGenerator object, datagenerator.

Examples

collapse all

The getNumDataPointsInfo function returns information related to the number of data points in the data generated from a fixed.DataGenerator object.

dataspec = fixed.DataSpecification('fixdt(1,16,13)',...
 'Intervals', {-1,1})
dataspec = 

  fixed.DataSpecification with properties:

          DataTypeStr: 'sfix16_En13'
            Intervals: [-1,1]
      MandatoryValues: <empty>
           Complexity: 'real'
           Dimensions: 1
datagen = fixed.DataGenerator('DataSpecifications', dataspec,...
 'NumDataPointsLimit', 20);
getNumDataPointsInfo(datagen)
ans = 

  struct with fields:

    Current: 20
       Next: 21
        Min: 5
        Max: 75

The output indicates that there are currently 20 data combinations in the generated data. The maximum number of combinations that the DataGenerator object would produce is 75.

When the dimension of the generated data is greater than one, it can be useful to find the next possible size of generated data.

Create a DataGenerator object where the associated DataSpecification object specifies 2-dimensional data.

dataspec = fixed.DataSpecification('single', 'Dimensions', 2);
datagen = fixed.DataGenerator('DataSpecifications', dataspec)
datagen = 

  fixed.DataGenerator with properties:

    DataSpecifications: {[1×1 fixed.DataSpecification]}
    NumDataPointsLimit: 100000

The DataGenerator object uses the default limit of 100000 data points in the generated data.

Get information about the number of data points generated.

getNumDataPointsInfo(datagen)
ans = 

  struct with fields:

    Current: 99856
       Next: 100489
        Min: 81
        Max: 130321

The current size of the generated data is 99856 points. By setting the NumDataPointsLimit property of the DataGenerator object to the value specified in Max, you can get the maximum possible number of data combinations.

Set the NumDataPointsLimit property of the DataGenerator object to the maximum possible number of data points.

datagen.NumDataPointsLimit = 130321;
getNumDataPointsInfo(datagen)
ans = 

  struct with fields:

    Current: 130321
       Next: 130321
        Min: 81
        Max: 130321

Input Arguments

collapse all

Object from which you want to get information, specified as a fixed.DataGenerator object.

Output Arguments

collapse all

Information about the number of data points in the data generated from a fixed.DataGenerator object, returned as a struct with the following fields.

FieldDescription
CurrentThe number of data combinations in the generated data.
NextNext possible size of data combinations.
Min

Minimum number of combinations of data required to be in the generated data.

This number is equal to the number of boundary values and mandatory values in the DataSpecification objects associated with the DataGenerator object.

Max

Maximum number of combinations that could be in the generated data.

Introduced in R2019b