microsoft-visualbasic-runtime/Text/Xml/Models/Vector.vb

#Region "Microsoft.VisualBasic::66246ecfcb788370cee68475bb8589c9, Microsoft.VisualBasic.Core\Text\Xml\Models\Vector.vb"

    ' Author:
    ' 
    '       asuka (amethyst.asuka@gcmodeller.org)
    '       xie (genetics@smrucc.org)
    '       xieguigang (xie.guigang@live.com)
    ' 
    ' Copyright (c) 2018 GPL3 Licensed
    ' 
    ' 
    ' GNU GENERAL PUBLIC LICENSE (GPL3)
    ' 
    ' 
    ' This program is free software: you can redistribute it and/or modify
    ' it under the terms of the GNU General Public License as published by
    ' the Free Software Foundation, either version 3 of the License, or
    ' (at your option) any later version.
    ' 
    ' This program is distributed in the hope that it will be useful,
    ' but WITHOUT ANY WARRANTY; without even the implied warranty of
    ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ' GNU General Public License for more details.
    ' 
    ' You should have received a copy of the GNU General Public License
    ' along with this program. If not, see <http://www.gnu.org/licenses/>.



    ' /********************************************************************************/

    ' Summaries:

    '     Class NumericVector
    ' 
    '         Properties: Length, name, vector
    ' 
    '         Function: GenericEnumerator, GetEnumerator, SequenceEqual, ToString
    ' 
    '     Class TermsVector
    ' 
    '         Properties: terms
    ' 
    '         Function: GenericEnumerator, GetEnumerator, ToString
    ' 
    ' 
    ' /********************************************************************************/

#End Region

Imports System.Runtime.CompilerServices
Imports System.Xml.Serialization
Imports Microsoft.VisualBasic.Language
Imports Microsoft.VisualBasic.Linq
Imports Microsoft.VisualBasic.Serialization.JSON

Namespace Text.Xml.Models

    ''' <summary>
    ''' A <see cref="Double"/> type numeric sequence container
    ''' </summary>
    <XmlType("numerics")>
    Public Class NumericVector : Implements Enumeration(Of Double)

        ''' <summary>
        ''' 可以用这个属性来简单的标记这个向量所属的对象名称
        ''' </summary>
        ''' <returns></returns>
        <XmlAttribute> Public Property name As String
        ''' <summary>
        ''' 存储于XML文档之中的数据向量
        ''' </summary>
        ''' <returns></returns>
        <XmlAttribute> Public Property vector As Double()

        ''' <summary>
        ''' Get/Set Element ``Xi``
        ''' </summary>
        ''' <param name="i"></param>
        ''' <returns></returns>
        Default Public Property Xi(i As Integer) As Double
            <MethodImpl(MethodImplOptions.AggressiveInlining)>
            Get
                Return vector(i)
            End Get
            Set(value As Double)
                vector(i) = value
            End Set
        End Property

        ''' <summary>
        ''' The vector length for counting the elements in <see cref="Vector"/> property.
        ''' </summary>
        ''' <returns></returns>
        Public ReadOnly Property Length As Integer
            <MethodImpl(MethodImplOptions.AggressiveInlining)>
            Get
                Return CInt(vector?.Length)
            End Get
        End Property

        Public Overrides Function ToString() As String
            If name.StringEmpty Then
                Return vector.GetJson
            Else
                Return $"Dim {name} As Vector = {vector.GetJson}"
            End If
        End Function

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        Public Shared Widening Operator CType(v As Double()) As NumericVector
            Return New NumericVector With {.name = "NULL", .vector = v}
        End Operator

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        Public Shared Widening Operator CType(v As List(Of Double)) As NumericVector
            Return New NumericVector With {.name = "NULL", .vector = v}
        End Operator

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        Public Shared Widening Operator CType(v As Integer()) As NumericVector
            Return New NumericVector With {
                .name = "NULL",
                .vector = v.Select(Function(x) CDbl(x)).ToArray
            }
        End Operator

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        Public Shared Narrowing Operator CType(v As NumericVector) As Double()
            Return v.vector
        End Operator

        <MethodImpl(MethodImplOptions.AggressiveInlining)>
        Public Function SequenceEqual(input() As Double) As Boolean
            Return vector.SequenceEqual(input)
        End Function

        Public Function GenericEnumerator() As IEnumerator(Of Double) Implements Enumeration(Of Double).GenericEnumerator
            Return vector.AsEnumerable.GetEnumerator
        End Function

        Public Iterator Function GetEnumerator() As IEnumerator Implements Enumeration(Of Double).GetEnumerator
            Yield GenericEnumerator()
        End Function
    End Class

    Public Class TermsVector : Implements Enumeration(Of Double)

        <XmlAttribute>
        Public Property terms As String()

        Public Overrides Function ToString() As String
            Return terms.GetJson
        End Function

        Public Function GenericEnumerator() As IEnumerator(Of Double) Implements Enumeration(Of Double).GenericEnumerator
            Return terms.AsEnumerable.GetEnumerator
        End Function

        Public Iterator Function GetEnumerator() As IEnumerator Implements Enumeration(Of Double).GetEnumerator
            Yield GenericEnumerator()
        End Function
    End Class
End Namespace