Support for complex types (#2098)

* Implementation of Complex Numbers

* Inclusion of test case for WriteWaveformComplexF64

* Implementation of f32 and i16 and respective test cases

* Updated changelog and included examples

* Updated the metadata

* Remove log file

* Updated functions.py file and few minor cahnges

* Update Changelog.md file

* Updated minor change.

* Updated few minor fix

* Updated the waveform type as ctype

* Updated the seesion lock parameter for new arb functions

* Updated Code Review comments

* Change log code review comments included

* Removed RFSG specific changes and include complextype only if needed

* Removed RFSG specific changes

* Updated matchers and complextype file to be generated bsaed on condition if complex is used

* Updating spacing issue

* Updating the complex variables and code review comments incorporated

* Test case name change

* Updating minor fixes

* Updating the test cases

* Update i16 functions

* Update duplicate entries

* remove zone.identifier file changes.

* Updaed comments for are_complex_parameters_used

* Updated the numpy api names and description.

* Updating default value of complext type as None rather than 'none'

* Moving the common lines in complex matchers into a function

* Updaing the library.py.mako file to import complex type

* Code Reivew Changes

* Updaed code review comments

* Updaing only necessary fields in COMPLEX_NUMBER_PARAMETERS

Author: rahulr-NI

build/helper/__init__.py

@@ -42,6 +42,7 @@
 
 from build.helper.metadata_add_all import add_all_metadata  # noqa: F401
 
+from build.helper.metadata_filters import are_complex_parameters_used  # noqa: F401
 from build.helper.metadata_filters import filter_codegen_attributes  # noqa: F401
 from build.helper.metadata_filters import filter_codegen_attributes_public_only  # noqa: F401
 from build.helper.metadata_filters import filter_codegen_enums  # noqa: F401

build/helper/codegen_helper.py

@@ -256,6 +256,10 @@ def get_ctype_variable_declaration_snippet(parameter, parameters, ivi_dance_step
     else:
         module_name = '_visatype'
 
+    # Use _complextype.py file for complex parameter
+    if parameter['complex_type'] is not None:
+        module_name = '_complextype'
+
     if parameter['is_string'] is True:
         definitions = _get_ctype_variable_definition_snippet_for_string(parameter, parameters, ivi_dance_step, module_name)
     elif parameter['is_buffer'] is True:
@@ -362,7 +366,12 @@ def _get_ctype_variable_definition_snippet_for_scalar(parameter, parameters, ivi
             definition = '{}.{}({})  # case S150'.format(module_name, parameter['ctypes_type'], parameter['python_name'])
         elif corresponding_buffer_parameters and corresponding_buffer_parameters[0]['direction'] == 'in':  # We are only looking at the first one to see if it is 'in'. Assumes all are the same here, assert below if not
             # Parameter denotes the size of another (the "corresponding") parameter.
-            definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else len({2}))  # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
+            # Interleaved array length is going to be double the length of number of samples.
+            # This is used for complex waveforms, where the real and imaginary parts are interleaved in the array.
+            if corresponding_buffer_parameters[0]['complex_type'] == 'interleaved':
+                definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else len({2}) // 2)  # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
+            else:
+                definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else len({2}))  # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
         else:
             if corresponding_buffer_parameters[0]['size']['mechanism'] == 'ivi-dance':  # We are only looking at the first one. Assumes all are the same here, assert below if not
                 # Verify all corresponding_buffer_parameters are 'out' and 'ivi-dance'
@@ -426,7 +435,10 @@ def _get_ctype_variable_definition_snippet_for_buffers(parameter, parameters, iv
     definition = None
 
     if parameter['numpy'] is True and use_numpy_array is True:
-        definition = '_get_ctypes_pointer_for_buffer(value={})  # case B510'.format(parameter['python_name'])
+        if parameter['complex_type'] is None:
+            definition = '_get_ctypes_pointer_for_buffer(value={})  # case B510'.format(parameter['python_name'])
+        else:
+            definition = '_get_ctypes_pointer_for_buffer(value={}, library_type={}.{})  # case B510'.format(parameter['python_name'], module_name, parameter['ctypes_type'])
     elif parameter['direction'] == 'in':
         if custom_type is not None:
             definition = '_get_ctypes_pointer_for_buffer([{0}.{1}(c) for c in {2}], library_type={0}.{1})  # case B540'.format(module_name, parameter['ctypes_type'], parameter['python_name'])

build/helper/helper.py

@@ -7,25 +7,28 @@
 
 # noqa statements because we want to format the table in a readable way
 _type_map = {
-    'ViConstString': { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViString':      { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViInt8':        { 'array_type': 'b',      'python_type': 'int',   'numpy_type': 'int8',       },  # noqa: E201, E202, E241
-    'ViUInt8':       { 'array_type': 'B',      'python_type': 'int',   'numpy_type': 'uint8',      },  # noqa: E201, E202, E241
-    'ViInt16':       { 'array_type': 'h',      'python_type': 'int',   'numpy_type': 'int16',      },  # noqa: E201, E202, E241
-    'ViUInt16':      { 'array_type': 'H',      'python_type': 'int',   'numpy_type': 'uint16',     },  # noqa: E201, E202, E241
-    'ViInt32':       { 'array_type': 'l',      'python_type': 'int',   'numpy_type': 'int32',      },  # noqa: E201, E202, E241
-    'ViUInt32':      { 'array_type': 'L',      'python_type': 'int',   'numpy_type': 'uint32',     },  # noqa: E201, E202, E241
-    'ViInt64':       { 'array_type': 'q',      'python_type': 'int',   'numpy_type': 'int64',      },  # noqa: E201, E202, E241
-    'ViUInt64':      { 'array_type': 'Q',      'python_type': 'int',   'numpy_type': 'uint64',     },  # noqa: E201, E202, E241
-    'ViReal32':      { 'array_type': 'f',      'python_type': 'float', 'numpy_type': 'float32',    },  # noqa: E201, E202, E241
-    'ViReal64':      { 'array_type': 'd',      'python_type': 'float', 'numpy_type': 'float64',    },  # noqa: E201, E202, E241
-    'ViStatus':      { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViSession':     { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViAttr':        { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViChar':        { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViChar[]':      { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViBoolean':     { 'array_type': None,     'python_type': 'bool',  'numpy_type': None,         },  # noqa: E201, E202, E241
-    'ViRsrc':        { 'array_type': None,     'python_type': 'str',   'numpy_type': 'bool_',      },  # noqa: E201, E202, E241
+    'ViConstString':      { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViString':           { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViInt8':             { 'array_type': 'b',      'python_type': 'int',   'numpy_type': 'int8',       },  # noqa: E201, E202, E241
+    'ViUInt8':            { 'array_type': 'B',      'python_type': 'int',   'numpy_type': 'uint8',      },  # noqa: E201, E202, E241
+    'ViInt16':            { 'array_type': 'h',      'python_type': 'int',   'numpy_type': 'int16',      },  # noqa: E201, E202, E241
+    'ViUInt16':           { 'array_type': 'H',      'python_type': 'int',   'numpy_type': 'uint16',     },  # noqa: E201, E202, E241
+    'ViInt32':            { 'array_type': 'l',      'python_type': 'int',   'numpy_type': 'int32',      },  # noqa: E201, E202, E241
+    'ViUInt32':           { 'array_type': 'L',      'python_type': 'int',   'numpy_type': 'uint32',     },  # noqa: E201, E202, E241
+    'ViInt64':            { 'array_type': 'q',      'python_type': 'int',   'numpy_type': 'int64',      },  # noqa: E201, E202, E241
+    'ViUInt64':           { 'array_type': 'Q',      'python_type': 'int',   'numpy_type': 'uint64',     },  # noqa: E201, E202, E241
+    'ViReal32':           { 'array_type': 'f',      'python_type': 'float', 'numpy_type': 'float32',    },  # noqa: E201, E202, E241
+    'ViReal64':           { 'array_type': 'd',      'python_type': 'float', 'numpy_type': 'float64',    },  # noqa: E201, E202, E241
+    'ViStatus':           { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViSession':          { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViAttr':             { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViChar':             { 'array_type': None,     'python_type': 'int',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViChar[]':           { 'array_type': None,     'python_type': 'str',   'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViBoolean':          { 'array_type': None,     'python_type': 'bool',  'numpy_type': None,         },  # noqa: E201, E202, E241
+    'ViRsrc':             { 'array_type': None,     'python_type': 'str',   'numpy_type': 'bool_',      },  # noqa: E201, E202, E241
+    'NIComplexNumber':    { 'array_type': None,     'python_type': None,    'numpy_type': 'complex128', },  # noqa: E201, E202, E241
+    'NIComplexNumberF32': { 'array_type': None,     'python_type': None,    'numpy_type': 'complex64',  },  # noqa: E201, E202, E241
+    'NIComplexI16':       { 'array_type': None,     'python_type': None,    'numpy_type': 'int16',      },  # noqa: E201, E202, E241
 }
 
 

build/helper/metadata_add_all.py

@@ -126,6 +126,12 @@ def _add_ctypes_type(parameter, config):
         parameter['ctypes_type_library_call'] = module_name + parameter['ctypes_type']
 
 
+def _add_complex_type(parameter):
+    '''Adds a complex_type parameter to the metadata for complex numbers'''
+    if 'complex_type' not in parameter:
+        parameter['complex_type'] = None
+
+
 def _add_numpy_info(parameter, parameters, config):
     '''Adds the following numpy-related information:
 
@@ -450,6 +456,7 @@ def add_all_function_metadata(functions, config):
             _add_python_type(p, config)
             _add_ctypes_variable_name(p)
             _add_ctypes_type(p, config)
+            _add_complex_type(p)
             _add_numpy_info(p, functions[f]['parameters'], config)
             _add_default_value_name(p)
             _add_default_value_name_for_docs(p, config['module_name'])

build/helper/metadata_filters.py

@@ -19,6 +19,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'fixed, passed-in, len',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.SESSION_METHOD_PASSTHROUGH_CALL: {
         'skip_session_handle': True,
@@ -33,6 +34,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'fixed, passed-in, len',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.SESSION_NUMPY_INTO_METHOD_DECLARATION: {
         'skip_session_handle': True,
@@ -47,6 +49,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'fixed, passed-in',
         'python_api_list': False,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.INTERPRETER_NUMPY_INTO_METHOD_DECLARATION: {
         'skip_session_handle': True,
@@ -61,6 +64,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'fixed, passed-in',
         'python_api_list': False,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.SESSION_METHOD_CALL: {
         'skip_session_handle': True,
@@ -75,6 +79,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'fixed, passed-in',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.DOCUMENTATION_SESSION_METHOD: {
         'skip_session_handle': True,
@@ -89,6 +94,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.LIBRARY_METHOD_DECLARATION: {
         'skip_session_handle': False,
@@ -103,6 +109,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.LIBRARY_METHOD_CALL: {
         'skip_session_handle': False,
@@ -117,6 +124,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.GRPC_REQUEST_PARAMETERS: {
         'skip_session_handle': False,
@@ -131,6 +139,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.CTYPES_ARGTYPES: {
         'skip_session_handle': False,
@@ -145,6 +154,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.INTERPRETER_METHOD_DECLARATION: {
         'skip_session_handle': True,
@@ -159,6 +169,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'fixed, passed-in, len',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.INPUT_PARAMETERS: {
         'skip_session_handle': True,
@@ -173,6 +184,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.LIBRARY_OUTPUT_PARAMETERS: {
         'skip_session_handle': True,
@@ -187,6 +199,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.API_OUTPUT_PARAMETERS: {
         'skip_session_handle': True,
@@ -201,6 +214,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': False,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.API_NUMPY_OUTPUT_PARAMETERS: {
         'skip_session_handle': True,
@@ -215,6 +229,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': False,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.GRPC_OUTPUT_PARAMETERS: {
         'skip_session_handle': True,
@@ -229,6 +244,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': False,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.NUMPY_PARAMETERS: {
         'skip_session_handle': True,
@@ -243,6 +259,7 @@
         'skip_all_except_numpy_parameters': True,
         'mechanism': 'any',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.IVI_DANCE_PARAMETER: {
         'skip_session_handle': True,
@@ -257,6 +274,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'ivi-dance, ivi-dance-with-a-twist',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.LEN_PARAMETER: {
         'skip_session_handle': True,
@@ -271,6 +289,7 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'len',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
     },
     ParameterUsageOptions.INPUT_ENUM_PARAMETERS: {
         'skip_session_handle': True,
@@ -285,6 +304,22 @@
         'skip_all_except_numpy_parameters': False,
         'mechanism': 'any',
         'python_api_list': True,
+        'skip_all_except_complex_type_parameters': False,
+    },
+    ParameterUsageOptions.COMPLEX_NUMBER_PARAMETERS: {
+        'skip_session_handle': True,
+        'skip_input_parameters': False,
+        'skip_output_parameters': False,
+        'but_keep_output_numpy_array_parameters': False,
+        'skip_size_parameter': False,
+        'reordered_for_default_values': False,
+        'skip_repeated_capability_parameter': False,
+        'skip_non_enum_parameter': False,
+        'skip_numpy_parameters': False,
+        'skip_all_except_numpy_parameters': False,
+        'mechanism': 'any',
+        'python_api_list': True,
+        'skip_all_except_complex_type_parameters': True,
     },
 }
 
@@ -349,6 +384,8 @@ def filter_parameters(parameters, parameter_usage_options):
             skip = False
         if not options_to_use['python_api_list'] and not x['use_in_python_api']:
             skip = True
+        if options_to_use['skip_all_except_complex_type_parameters'] and x['complex_type'] is None:
+            skip = True
         if not skip:
             parameters_to_use.append(x)
 
@@ -451,3 +488,13 @@ def filter_codegen_enums(enums):
     return {k: v for k, v in enums.items() if v['codegen_method'] != 'no'}
 
 
+def are_complex_parameters_used(functions):
+    '''Returns bool based on whether any complex parameters are used in the functions metadata.'''
+    are_complex_parameters_used = False
+    complex_parameters = []
+    for k, v in functions.items():
+        complex_parameters = filter_parameters(v['parameters'], ParameterUsageOptions.COMPLEX_NUMBER_PARAMETERS)
+        if complex_parameters != []:
+            are_complex_parameters_used = True
+            break
+    return are_complex_parameters_used

build/helper/parameter_usage_options.py

@@ -62,3 +62,5 @@ class ParameterUsageOptions(AutoNumber):
     '''Get the len parameter'''
     INPUT_ENUM_PARAMETERS = ()
     '''Get any input parameters whose type is enum'''
+    COMPLEX_NUMBER_PARAMETERS = ()
+    '''Get all parameters of complex type'''

build/templates/_complextype.py.mako

@@ -0,0 +1,21 @@
+${template_parameters['encoding_tag']}
+# This file was generated
+<%
+    import build.helper as helper
+    config = template_parameters['metadata'].config
+    module_name = config['module_name']
+%>\
+import ctypes
+import ${module_name}._visatype as _visatype
+
+
+class NIComplexNumber(ctypes.Structure):
+    _fields_ = [("real", _visatype.ViReal64), ("imag", _visatype.ViReal64)]
+
+
+class NIComplexNumberF32(ctypes.Structure):
+    _fields_ = [("real", _visatype.ViReal32), ("imag", _visatype.ViReal32)]
+
+
+class NIComplexI16(ctypes.Structure):
+    _fields_ = [("real", _visatype.ViInt16), ("imag", _visatype.ViInt16)]

build/templates/_library.py.mako

@@ -12,12 +12,16 @@ driver_name = config['driver_name']
 
 functions = config['functions']
 functions = helper.filter_library_functions(functions)
+are_complex_parameters_used = helper.are_complex_parameters_used(functions)
 %>\
 
 import ctypes
 import ${module_name}.errors as errors
 import threading
 
+% if are_complex_parameters_used:
+from ${module_name}._complextype import *  # noqa: F403
+% endif
 from ${module_name}._visatype import *  # noqa: F403,H303
 % for c in config['custom_types']: