Skip to content

Commit 8f47a05

Browse files
authored
up version (#189)
1 parent 75df29c commit 8f47a05

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

docs/src/transformations.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,14 @@ CurrentModule = Copulas
99

1010
```@docs
1111
SurvivalCopula
12+
```
13+
14+
## `SubsetCopula`
15+
16+
```@docs
17+
Copulas.subsetdims
18+
```
19+
20+
```@docs
21+
Copulas.SubsetCopula
1222
```

src/SubsetCopula.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Constructor
99
1010
SubsetCopula(C::Copula,dims)
1111
12-
This class allows to construct a random vector specified as X[dims] where X is the random vector correspnding to C and dims is a selection of dimensions.
12+
This class allows to construct a random vector corresponding to a few dimensions of the starting copula. If ``(X_1,...,X_n)`` is the random vector corresponding to the copula `C`, this returns the copula of `(` ``X_i`` `for i in dims)`. The dependence structure is preserved. There are specialized methods for some copulas.
1313
"""
1414
struct SubsetCopula{d,CT} <: Copula{d}
1515
C::CT
@@ -50,7 +50,7 @@ SubsetCopula(C::ArchimedeanCopula{d,TG},dims) where {d,TG} = ArchimedeanCopula(l
5050
subsetdims(C::Copula,dims)
5151
subsetdims(D::SklarDist, dims)
5252
53-
If X is the random vector corresponding to `C` or `D`, this returns the distributions of C[dims]. Has specialized methods for some copulas.
53+
If ``(X_1,...,X_n)`` is the random vector corresponding to the model `C` or `D`, this returns the distribution on `(` ``X_i`` `for i in dims)`, preserving the dependence structure between the dimensions in `dims`. There are specialized methods for some copulas.
5454
"""
5555
subsetdims(C::Copula{d},dims) where d = SubsetCopula(C,dims)
5656
subsetdims(D::SklarDist, dims) = SklarDist(subsetdims(D.C,dims), Tuple(D.m[i] for i in dims))

0 commit comments

Comments
 (0)