#===============================================================================
# Copyright 2014-2017 Intel Corporation
# All Rights Reserved.
#
# If this  software was obtained  under the  Intel Simplified  Software License,
# the following terms apply:
#
# The source code,  information  and material  ("Material") contained  herein is
# owned by Intel Corporation or its  suppliers or licensors,  and  title to such
# Material remains with Intel  Corporation or its  suppliers or  licensors.  The
# Material  contains  proprietary  information  of  Intel or  its suppliers  and
# licensors.  The Material is protected by  worldwide copyright  laws and treaty
# provisions.  No part  of  the  Material   may  be  used,  copied,  reproduced,
# modified, published,  uploaded, posted, transmitted,  distributed or disclosed
# in any way without Intel's prior express written permission.  No license under
# any patent,  copyright or other  intellectual property rights  in the Material
# is granted to  or  conferred  upon  you,  either   expressly,  by implication,
# inducement,  estoppel  or  otherwise.  Any  license   under such  intellectual
# property rights must be express and approved by Intel in writing.
#
# Unless otherwise agreed by Intel in writing,  you may not remove or alter this
# notice or  any  other  notice   embedded  in  Materials  by  Intel  or Intel's
# suppliers or licensors in any way.
#
#
# If this  software  was obtained  under the  Apache License,  Version  2.0 (the
# "License"), the following terms apply:
#
# You may  not use this  file except  in compliance  with  the License.  You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
#
# Unless  required  by   applicable  law  or  agreed  to  in  writing,  software
# distributed under the License  is distributed  on an  "AS IS"  BASIS,  WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#
# See the   License  for the   specific  language   governing   permissions  and
# limitations under the License.
#===============================================================================

## <a name="DAAL-EXAMPLE-PY-DATASTRUCTURES_AOS"></a>
## @example datastructures_aos.py

import os
import sys

import numpy as np

from daal.data_management import data_feature_utils, AOSNumericTable, BlockDescriptor, readOnly, readWrite

utils_folder = os.path.realpath(os.path.abspath(os.path.dirname(os.path.dirname(__file__))))
if utils_folder not in sys.path:
    sys.path.insert(0, utils_folder)
from utils import printArray


if __name__ == "__main__":

    print("Array of structures (AOS) numeric table example\n")

    points = np.array([(0.5, -1.3, 1, 100.1),
                       (2.5, -3.3, 2, 200.2),
                       (4.5, -5.3, 2, 350.3),
                       (6.5, -7.3, 0, 470.4),
                       (8.5, -9.3, 1, 270.5)],
                      dtype=[('x','f4'), ('y','f4'), ('categ','i4'), ('value','f8')])

    nObservations = len(points)
    nFeatures = len(points[0])

    # Construct AOS numericTable for a data array with nFeatures fields and nObservations elements
    # Dictionary will be initialized with type information from ndarray
    dataTable = AOSNumericTable(points)

    #  Get the dictionary and update it with additional information about data
    dict = dataTable.getDictionary()

    #  Add a feature type to the dictionary
    dict[0].featureType = data_feature_utils.DAAL_CONTINUOUS
    dict[1].featureType = data_feature_utils.DAAL_CONTINUOUS
    dict[2].featureType = data_feature_utils.DAAL_CATEGORICAL
    dict[3].featureType = data_feature_utils.DAAL_CONTINUOUS

    #  Set the number of categories for a categorical feature
    dict[2].categoryNumber = 3

    #  Read a block of rows
    firstReadRow = 0
    doubleBlock = BlockDescriptor()
    dataTable.getBlockOfRows(firstReadRow, nObservations, readWrite, doubleBlock)
    printArray(
        doubleBlock.getArray(), nFeatures, doubleBlock.getNumberOfRows(),
        doubleBlock.getNumberOfColumns(),"Print AOS data structures as double:"
    )
    dataTable.releaseBlockOfRows(doubleBlock)

    #  Read a feature (column)
    readFeatureIdx = 2

    intBlock = BlockDescriptor(ntype=np.intc)
    dataTable.getBlockOfColumnValues(readFeatureIdx, firstReadRow, nObservations, readOnly, intBlock)
    printArray(
        intBlock.getArray(), 1, intBlock.getNumberOfRows(), intBlock.getNumberOfColumns(),
        "Print the third feature of AOS:", flt64=False
    )
    dataTable.releaseBlockOfColumnValues(intBlock)
