forked from docarray/docarray
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmatch.py
More file actions
63 lines (52 loc) · 1.78 KB
/
match.py
File metadata and controls
63 lines (52 loc) · 1.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
import itertools
from typing import (
TYPE_CHECKING,
Generator,
Iterator,
Sequence,
)
from .. import DocumentArray
if TYPE_CHECKING:
from ..document import Document
class MatchArray(DocumentArray):
"""
:class:`MatchArray` inherits from :class:`DocumentArray`.
It's a subset of Documents that represents the matches
:param docs: Set of matches of the `reference_doc`
:param reference_doc: Reference :class:`Document` for the sub-documents
"""
def __init__(self, docs, reference_doc: 'Document'):
self._ref_doc = reference_doc
super().__init__(docs)
if (
isinstance(
docs, (DocumentArray, Sequence, Generator, Iterator, itertools.chain)
)
and self._ref_doc is not None
):
for d in docs:
d.adjacency = self._ref_doc.adjacency + 1
def append(self, document: 'Document'):
"""Add a matched document to the current Document.
:param document: Sub-document to be added
"""
document.adjacency = self._ref_doc.adjacency + 1
super().append(document)
@property
def reference_doc(self) -> 'Document':
"""Get the document that this :class:`MatchArray` referring to.
:return: the document the match refers to
"""
return self._ref_doc
@property
def granularity(self) -> int:
"""Get granularity of all document in this array.
:return: the granularity of the documents of which these are match
"""
return self._ref_doc.granularity
@property
def adjacency(self) -> int:
"""Get the adjacency of all document in this array.
:return: the adjacency of the array of matches
"""
return self._ref_doc.adjacency + 1