Jak zadeklarować wejście do funkcji Rcpp?

Question

Jestem absolutnym Rcpp -begner, więc proszę was, ostrzeżcie, że wkrótce pojawi się pytanie początkującego.

Rozważmy przykład:

#include <Rcpp.h> 
using namespace Rcpp; 
// [[Rcpp::export]] 
NumericMatrix mat_1(NumericMatrix X){ 
do.stuff.with.X 
} 

Mi się, że definiuje funkcję mat_1 w obszarze roboczym R, które ma matrycę liczbową na wejściu i zwraca matrycę numerycznej w końcu. Jednakże looking e.g. here I rozumie, że można również określić

SEXP mat_2(SEXP X){ 
Rcpp::NumericMatrix x(X);     
do.stuff.with.x 
} 

lub alternatywnie

SEXP mat_3(SEXP X){ 
NumericMatrix x(as<NumericMatrix>(X)) 
do.stuff.with.x 
} 

Mi się, że określa wyjście funkcji jako S-ekspresji, i wymaga S ekspresję jako wejście, które jest wewnętrznie przekonwertowane (?) na macierz numeryczną.

Teraz looking at this document, który był bardzo cennym źródłem do mnie, ja dowiedziałem się, że mogę również napisać

NumericMatrix mat_4(NumericMatrix X&){ 
do.stuff.with.X 
} 

Tutaj mój zrozumienia jest to, że zamiast tworzenia kopii X, tym Rcpp -function używa odwołania do obiektu R. W rzeczywistości nie jestem pewien, czy rozumiem, co to oznacza. Czy nie było sensu używać SEXP, że nie wykonano żadnej kopii, czy też coś złego? Ponadto, jeśli oszczędza pamięć, a zatem jest bardziej wydajny, dlaczego miałbym kiedykolwiek użyć czegoś innego?

Jestem pewien, że przegapiłem kilka opcji. W każdym razie, moje wielkie pytanie jest następujące: z punktu widzenia użytkownika R (ja), wywołuję każdą funkcję mat_1, mat_2, mat_3 lub mat_4 dostarczając matrycę numeryczną (która jest obiektem R w moim obszarze roboczym, a zatem SEXP), i wydaje się, że powinienem otrzymać to samo wyjście (macierz numeryczna, która będzie z perspektywy SEXP z perspektywy R, prawda?). Byłbym wdzięczny za wskazówki dotyczące względnych zalet tych pozornie identycznych sposobów definiowania funkcji. Oznacza to, że przy założeniu, że wiemy dokładnie, jaka funkcja będzie wejście i wyjście co będzie,

1. Dlaczego i kiedy ma się opłacać używać NumericMatrix zamiast SEXP dla argumentu, lub odwrotnie?
2. Dlaczego i kiedy używać &?
3. Jeśli wiem, że funkcja zwróci macierz numeryczną, czy istnieją powody, aby zadeklarować funkcję jako SEXP? Czy są powody, aby trzymać się NumericMatrix?

A może zupełnie nie rozumiem?

Co więcej, czy istnieje jakaś praktyczna różnica między konwersją użytą w mat_2 i mat_3? Czy są jakieś różnice między Rcpp::NumericMatrix x(X) i NumericMatrix x(as<NumericMatrix>(X))?

Wszelkie uwagi są mile widziane.

Answer 1

W porządku. Próbuję podać jakieś wskazówki.Po pierwsze, jeśli jesteś początkującym, dobrze się z pierwszą funkcją, użyj mat_1. Gdy twoje umiejętności się poprawią, możesz zrozumieć niektóre różnice między mat_1, a drugą, i ostatecznie przejść do ... użyć mat_1, ponieważ jest to ta, której chcesz użyć.

1. Zawsze. Większość użytkowników nie powinna nigdy używać numeru SEXP.
2. Nie ma to znaczenia w tym przypadku. Rcpp będzie wiedział, co zrobić z referencją, ale to, co się dzieje, jest prawie takie samo, tworzy obiekt lokalnie i daje do niego odniesienie. Rozróżnienie pomiędzy wartością przekazywaną przez wartość i przez odniesienie ma znaczenie, jeśli użytkownik zadzwonił, aby zadzwonić pod numer mat_4 z innej funkcji C++.
3. Jeśli znasz typ, użyj tego typu. To jest cały punkt Rcpp. SEXP to typ R dla wszystkich typów, jeśli zwrócisz SEXP, może to być cokolwiek, jeśli zwrócisz NumericMatrix wiesz, że dzięki zwróceniu matrycy numerycznej masz ogromną przewagę i prawie cały powód, dla którego istnieje Rcpp.

Pozwalam ci zdecydować, czy brakowało ci punktu.

Ogólnie rzecz biorąc as<> będzie starał się trudniej, ale to nie ma znaczenia w tym przypadku.

W skrócie: użyj mat_1. Jest jeszcze wiele innych rzeczy do nauczenia się, nie martw się o to jeszcze.